Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Idempotency-Key
string

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

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-13"

Body

application/json
content
string
required

Main body text of the notification.

Example:

"Drop off at 4180 Burnet Rd. Plan on two days for the full coating."

title
string
required

Headline text of the notification.

Example:

"Your ceramic coating is booked"

account_id
string

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

Example:

"biz_xxxxxxxxxxxxxx"

experience_id
string

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

Example:

"exp_xxxxxxxxxxxxxx"

icon_user_id
string | null

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

Example:

"user_xxxxxxxxxxxxxx"

rest_path
string | null

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

Example:

"/bookings/upcoming"

subtitle
string | null

Optional secondary line displayed below the title.

Example:

"Tuesday 9:00 AM, Bay 2"

user_ids
string[]

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.

Response

notification queued

success
boolean
required
Example:

true