Alerts

Update an alert

Update mutable fields. Campsites cannot be changed — delete and recreate to change monitored campgrounds.

patch/alerts/{alertId}

Request

  • Base URL: https://outdoorithm.com/api/v1
  • URL: https://outdoorithm.com/api/v1/alerts/{alertId}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

alertIdstring required

The alert UUID.

Query parameters

end_user_idstring

Required for partner keys: the customer that owns this alert. A different customer receives the same 404 as an unknown alert.

Example:your-user-8412

Request body

namestring
descriptionstring
status'active' | 'paused'
date_type'range' | 'perpetual' | 'specific_months'
start_datestring
end_datestring
specific_monthsinteger[]
recurringboolean
days_of_weekinteger[]
min_nightsinteger
max_nightsinteger
notify_emailboolean
notify_smsboolean
notify_in_appboolean

Response

The updated alert.

Changes

No recorded changes to this operation across all 1 revision of this API.