SendInstantPush

post

https://api.dengage.com/rest/push/sendInstant

SendInstantPush is used to send quick mobile/web push messages without complex customization or frequency capping. Basic customization can be applied to content via contact fields(such as name, surname, etc.).

For multi language send, the multiLangContent property or a template id created as multi language should be selected.

** You cannot use multiLangContent and content properties at the same time.

Body Params

The request body containts tableId or segmentId in order to target the audiences.

The content can be copied from a template. Please use only templateId under Content object. Or you may want to create a different content. Please use the fields under Content and leave templateId empty.

applicationIds

array of strings

required

The targetted application ids to send push messages to.

The tokens in these application ids used in sending.

If it is not provided, sending will prepared for all application ids.

applicationIds*

content

object

required

The content that will be sent to selected audience.

multiLangContent

object

This field, used to send multi language.

scheduleDate

enum

If scheduleDate value is null, send starts immediately.

scheduleDate should be given in UTC time.

Allowed:

segmentId

uuid

id of the segment where the devices to be selected for sending.

tableId

uuid

id of the table where the devices to be selected for sending.

trackingId

uuid

Can be used to provide your own tracking id to track the sending. The given field must be a UUID.

if tracking id is not provided, system will generate a UUID for the sending and return as tracking id in response.

useOnlyEngagedTokens

boolean

If you want to send only last engaged tokens, please set it true. Otherwise it will go to all reachable tokens.

Token engagement is the token that receives events such as open or click events from previously sent push messages.

Headers

Authorization

string

Defaults to {$$.env.access_token}

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Not authenticated. Please re-login.

403

The operation is not allowed. Your api user is not authorized to use this api.

404

The template id you have set not found.

429

Too Many Requests

200The request has been queued and quick push send has been started.

400There is a problem with the request. Some objects are not found.

422There is a problem with your request. Please check the code and message in the response.