Sign in
OpenAPI 3.1.02026-08-143874115.7 MB

a84d4905fdbb

Notifications

Send Notification

Queues a notification to every user of an experience or to an account's team, processed asynchronously. Every send is attributed to an app: use an app API key, or a credential acting on behalf of an app. Narrow the audience with user_ids to send a mention.

post/notifications

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring

Account whose team members receive the notification (biz_ tag). Exactly one of experience_id or account_id is required.

contentstring required

Main body text of the notification.

experience_idstring

Experience whose users receive the notification (exp_ tag). Exactly one of experience_id or account_id is required.

icon_user_idstring nullable

User whose profile picture is used as the notification icon. Defaults to the experience or account avatar.

rest_pathstring nullable

Path segment appended to the generated deep link that opens your app, for example /settings/billing.

subtitlestring nullable

Optional secondary line displayed below the title.

titlestring required

Headline text of the notification.

user_idsstring[]

Optional user_ tags narrowing the audience. When provided, only these users are notified (as a mention), provided they are in the targeted experience or account.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "content": "Drop off at 4180 Burnet Rd. Plan on two days for the full coating.",
  "experience_id": "exp_xxxxxxxxxxxxxx",
  "icon_user_id": "user_xxxxxxxxxxxxxx",
  "rest_path": "/bookings/upcoming",
  "subtitle": "Tuesday 9:00 AM, Bay 2",
  "title": "Your ceramic coating is booked",
  "user_ids": [
    "user_xxxxxxxxxxxxxx"
  ]
}

Response

notification queued

successboolean required

Example response

{
  "success": true
}