> ## Documentation Index
> Fetch the complete documentation index at: https://docsv4.mile.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Update alert setting

> Updates the alert setting of your organization. Send at least one flag; flags you leave out keep their current value. Every flag is a boolean. Returns the full setting after the update.

Requires permission `edit/alertSetting`.



## OpenAPI

````yaml /openapi/public/openapi-monitoring.json put /alert-setting
openapi: 3.0.0
info:
  title: API - Monitoring
  version: 3.0.0
  description: API Documentation - RESTful API for field operations management.
servers:
  - url: https://apiweb.mile.app/api/v3
security:
  - bearerAuth: []
tags:
  - name: Alert
    description: >-
      An alert is an event raised while monitoring field users and vehicles, for
      example entering or leaving a geofence, idling too long, a predicted late
      task, a route deviation or a panic button press. You can list alerts, read
      a daily summary, and mark them resolved. These endpoints are served under
      `/api/v4`.
  - name: Alert Setting
    description: >-
      Alert settings switch each alert type on or off for your organization.
      These endpoints are served under `/api/v4`.
  - name: Geofence
    description: >-
      A geofence is an area drawn on the map, as a polygon or a circle. Alerts
      and automations can react when a field user enters or leaves it, or stays
      inside longer than its dwell time.
  - name: Geofence Group
    description: >-
      Geofence groups organize geofences so you can filter and manage them
      together.
paths:
  /alert-setting:
    servers:
      - url: https://apiweb.mile.app/api/v4
    put:
      tags:
        - Alert Setting
      summary: Update alert setting
      description: >-
        Updates the alert setting of your organization. Send at least one flag;
        flags you leave out keep their current value. Every flag is a boolean.
        Returns the full setting after the update.


        Requires permission `edit/alertSetting`.
      operationId: updateAlertSetting
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertSettingUpdateRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Status of response.
                  message:
                    description: Message of API response.
                    type: string
                  data:
                    description: Full alert setting after the update.
                    type: object
                    additionalProperties: true
                example:
                  status: true
                  message: Success
                  data:
                    geofence: true
                    idle: true
                    lateness: false
                    routeDeviation: false
                    geofenceNotification: true
                    idleNotification: false
                    latenessNotification: true
                    routeDeviationNotification: true
                    updatedBy: admin@example.com
                    updatedTime: '2026-10-10T04:00:00.000Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Bad request - invalid parameters provided.
      deprecated: false
      security:
        - bearerAuth: []
components:
  schemas:
    AlertSettingUpdateRequest:
      type: object
      description: At least one of the flags is required.
      properties:
        geofence:
          type: boolean
          description: |-
            Record geofence enter and leave alerts. Default `false`.
            **Example:** `true`
        idle:
          type: boolean
          description: |-
            Record idle alerts (driver stopped moving). Default `false`.
            **Example:** `true`
        lateness:
          type: boolean
          description: |-
            Record predicted task lateness alerts. Default `false`.
            **Example:** `false`
        routeDeviation:
          type: boolean
          description: |-
            Record route deviation alerts. Default `false`.
            **Example:** `false`
        geofenceNotification:
          type: boolean
          description: >-
            Also send recorded geofence alerts to the notification bell. Default
            `true`.

            **Example:** `true`
        idleNotification:
          type: boolean
          description: >-
            Also send recorded idle alerts to the notification bell. Default
            `true`.

            **Example:** `false`
        latenessNotification:
          type: boolean
          description: >-
            Also send recorded lateness alerts to the notification bell. Default
            `true`.

            **Example:** `true`
        routeDeviationNotification:
          type: boolean
          description: >-
            Also send recorded route deviation alerts to the notification bell.
            Default `true`.

            **Example:** `true`
      example:
        geofence: true
        idle: true
        idleNotification: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use a valid Bearer token to authenticate.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.