POST https://api-us.engagor.com/{account_id}/notifications/add

Description alpha

Sends a new notification (only available for allowlisted applications).

Required Access Token Scope

accounts_write

POST Parameters

Param Description Required Default Value
type The type of the profile you want to send the notification with. (E.g. `whatsapp`.) Yes
service_id The service ID of the profile you want to send the notification with. (E.g. The identifier of your own WhatsApp Profile. Find the identifier e.g. via the `/{account_id}/settings/topics` endpoint) Yes
to The service ID of the profile you want to send the notification to. (E.g. The WhatsApp Phone number of the user you want to reach, including country code.) Yes
message A JSON encoded message you want to send as a notification. Scheme might be different depending on which service to send the notification too. (See examples below for e.g. WhatsApp) Yes

Examples

Send a Notification to a WhatsApp Profile

Send a Notification to a WhatsApp Profile (via CloudApi)