Send a push notification

Dispatch a push notification of an existing category to a user of the authenticated organisation. Requires the manual-send feature to be enabled. The server-level category configuration and the recipient own preference still apply: when either suppresses the notification the response reports targetCount 0 with the reason. Devices registered against several signers of the same user are dispatched to once, so targetCount counts distinct destinations. Rate limited per caller to the configured PUSH_MANUAL_SEND_RATE_LIMIT_PER_MINUTE in a fixed 60s window; the window is per API instance, so with N instances the effective ceiling is N times the configured limit. Exceeding it returns 429 with meta.retryAfterSeconds. The notification is handed to the delivery pipeline before the response: when that dispatch is unavailable or fails, the call returns 503 rather than a positive targetCount.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Allowed:
string
required
length between 1 and 255
^\S+$

ID of the user to notify

string
length between 1 and 255
^\S+$

Restrict delivery to the devices of this signer. Must belong to the notified user. Omitted: every device of the user is targeted, narrowed to the request party when requestId is given.

string
length between 1 and 255
^\S+$

ID of the request the notification points at. Must be a request of the caller organisation that the notified user is party to, and its type must match the category. Delivery is narrowed to the devices of the notified user signers party to that request. Omitted: the notification taps through to the app home instead of a request.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json