Developer Guide

SendTransactionalPush

post
https://api.dengage.com/rest/transactional/push

Sends transactional push notifications to individual users. For multi-language sending, a template created as multi-language should be selected. Recipient language can be used as a parameter for sending with multi-language content. If recipient language is provided, this property is used as the user language; otherwise, device language is used. The endpoint supports SMS fallback functionality when push delivery fails.

Idempotency Support: This endpoint supports idempotency via the optional traceId parameter. For more information, see Rest API Idempotency.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid

Application identifier. Required when using token-based targeting.

string

Unique contact identifier. When using contactKey, appId is optional as the system will send to all registered devices for this contact. Required when using sendToAll parameter.

uuid
required

Push content template identifier. This field is required.

current
object

Current user context data for content personalization.

customParameters
array of objects

Additional parameters for content customization.

customParameters
fallbackChannel
object

SMS fallback configuration when push notification delivery fails.

inboxParams
object

Inbox configuration for storing the notification.

string

Recipient language override for multi-language templates. If provided, this language is used instead of the device's default language.

boolean

When true, sends to all registered devices for the specified contactKey. Can only be used with contactKey parameter, not with token.

tags
array of strings

Tags for categorizing and tracking the notification.

tags
string

Device token for direct device targeting. Cannot be used together with sendToAll parameter.

Headers
string
required
Defaults to {$$.env.access_token}
Responses

401

Not authenticated. The request lacks valid authentication credentials.

403

Forbidden. The API user is not authorized to use this endpoint or lacks the required TransactionalPush.Manage permission.

429

Too many requests. The concurrent request limit has been exceeded.

Updated 7 days ago

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

Updated 7 days ago