Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like 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-07-27"

Body

application/json
content
string
required

Main body text of the notification.

title
string
required

Headline text of the notification.

account_id
string

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

experience_id
string

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

icon_user_id
string | null

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

rest_path
string | null

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

subtitle
string | null

Optional secondary line displayed below the title.

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