messaging

Schedule a ServiceAlert to be sent out

Your systems can trigger a Service Alert that will be sent to residents that are signed up for regular reminders, or alert-only reminders.

post/areas/{area_id}/services/{svc_id}/alerts

Request

  • Base URL: https://api.recollect.net/api
  • URL: https://api.recollect.net/api/areas/{area_id}/services/{svc_id}/alerts
  • Auth: none declared

Path parameters

area_idstring required

Area ID or Area name can be used.

svc_idstring required

Service ID. When used with an Area, a Service name (like "waste") can be used.

Request body

targetstring email
zonesinteger[]
optsobject
send_atinteger
metadatastring

Response

201 Created - the resource was created.

Changes

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