# Update of Single Alert

Update a single alert

If an alert has been switched into an  state because the alert has completed every possible recurrence, the mutation must include a new RRULE that has at least one occurrence in the future.

Under the hood, PATCH is a get job, delete job, and create a job.

Note that the following parameters cannot be mutated via the PATCH:
- external_id
- uuid
- options

path parameter can only be the uuid

Endpoint: PATCH /api/v1/universal-alert/{uuid}
Security: ApiKey

## Path parameters:

  - `uuid` (string, required)

## Query parameters:

  - `network_id` (integer, required)
    Unique identifier of the network whose configuration should be managed

## Request fields (application/json):

  - `alert_name` (string)
    Default: ""
Defaults to an empty string if no value is provided.
    Example: "Change"

  - `enabled` (boolean, required)

  - `rrule` (string)
    The RRULE string which can be generated here: https://jakubroztocil.github.io/rrule/

Note that new lines must be explicitly escaped with \n. COUNT will always internally converted to 1 since computing every possible alert is not required. The cloud needs only to know when the single next alert is.

Example: DTSTART;TZID=America/New_York:20211201T163000\nRRULE:FREQ=WEEKLY;COUNT=30;INTERVAL=1;WKST=MO
    Example: "DTSTART;TZID=Europe/London:20220101T080000\r\nRRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU\r\n"

  - `analytics_tag` (string)
    Default: ""
Any string that can be used for analytics tracing. Defaults to "" if the field is not included.
    Example: "riseAndShinePreset"

  - `monitor` (object, required)
    This object defines the conditions and type of the motion monitor.
    Example: {"monitor_mode":"SIMPLE","duration_minutes":120}

  - `monitor.monitor_mode` (string)
    Enum: "NONE", "SIMPLE", "INACTIVITY"

  - `monitor.duration_minutes` (integer)
    The length of time in minutes of the monitored duration. The cloud will determine the start time per the timezone in the rrule field by subtracting this from the targeted time of the monitor completion (in which the result is sent).
    Example: 120

  - `monitor.inactive_minutes` (integer)
    Required if the  is "INACTIVITY"

  - `monitor.repeat_monitoring` (boolean)
    If the  is "INACTIVITY", this boolean determines if the alert should continue monitoring if inactivity is detected.

  - `monitor.stop_event_filter` (object)
    Not yet supported - 1/1/2022

The keys of the object will compare to keys of MQTT events as they are from core. All key value pairs placed in this object will be expected on the event from core.

  - `meta` (object)
    The contents of this object is fully decided by the client and will not persist anywhere if the alert is deleted.
    Example: {"alert_type":"RISE_AND_SHINE_PRESET"}

  - `meta.alert_type` (string)
    Example: "RISE_AND_SHINE_PRESET"

  - `motion_actions` (array)
    Example: [{"user_ids":[],"action":"fcm_push","payload":{"data":{"title":"Rise and Shine","body":"Your loved one has begun their day","click_action":"CustomAlertEvent","sound":"Aura_Push_Final.wav"},"apns":{"headers":{"apns-push-type":"alert","apns-topic":"com.csc.HaloHome"},"payload":{"aps":{"alert":{"title":"Rise and Shine","body":"Your loved one has begun their day"},"sound":"Aura_Push_Final.wav","category":"CustomAlertEvent"}}}}},{"user_ids":[],"action":"custom_event","payload":{"data":{"title":"Rise and Shine","body":"Your loved one has begun their day"}}}]

  - `motion_actions.action` (string, required)
    Supported actions are

  - `motion_actions.user_ids` (array)
    Array of user ids

  - `motion_actions.payload` (object)
    Payload to add to the action.


Data in payload should match API input for MNS /network/{network_id}/events/create


Data in payload should match API input for FireBase push API

  - `no_motion_actions` (array)
    Example: [{"user_ids":[],"action":"fcm_push","payload":{"data":{"title":"Rise and Shine","body":"Your loved one has not begun their day","click_action":"CustomAlertEvent","sound":"Aura_Push_Final.wav"},"apns":{"headers":{"apns-push-type":"alert","apns-topic":"com.csc.HaloHome"},"payload":{"aps":{"alert":{"title":"Rise and Shine","body":"Your loved one has not begun their day"},"sound":"Aura_Push_Final.wav","category":"CustomAlertEvent"}}}}},{"action":"custom_event","payload":{"data":{"title":"Rise and Shine","body":"Your loved one has not begun their day"}}}]

  - `unknown_actions` (array)
    Example: [{"user_ids":[],"action":"fcm_push","payload":{"data":{"title":"Rise and Shine","body":"Caregiver Aware could not determine motion in your home","click_action":"CustomAlertEvent","sound":"Aura_Push_Final.wav"},"apns":{"headers":{"apns-push-type":"alert","apns-topic":"com.csc.HaloHome"},"payload":{"aps":{"alert":{"title":"Rise and Shine","body":"Caregiver Aware could not determine motion in your home"},"sound":"Aura_Push_Final.wav","category":"CustomAlertEvent"}}}}},{"action":"custom_event","payload":{"data":{"title":"Rise and Shine","body":"Caregiver Aware could not determine motion in your home"}}}]

  - `error_actions` (array)
    Example: {"type":"Array","Items":{"user_ids":[],"action":"fcm_push","payload":{"data":{"title":"Rise and Shine","body":"Caregiver Aware could not determine motion in your home","click_action":"CustomAlertEvent","sound":"Aura_Push_Final.wav"},"apns":{"headers":{"apns-push-type":"alert","apns-topic":"com.csc.HaloHome"},"payload":{"aps":{"alert":{"title":"Rise and Shine","body":"Caregiver Aware could not determine motion in your home"},"sound":"Aura_Push_Final.wav","category":"CustomAlertEvent"}}}}}}