Developer Guide

SendTransactionalPushByTag

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

SendTransactionalPushByTag is utilized to send mobile/web push messages by filtering tags, simplifying the process without complex customization or frequency capping. Basic customization can be applied to content via contact fields (such as name, surname, etc.).

To learn more about Tagging, please visit our Tagging page.

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.

Note: Multi-language feature must be enabled in your account to use multiLangContent.

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

Body Params

The request body contains applicationIds and tagList 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.

Important: When using multiple tags, tagOperator is required.

applicationIds
array of uuids
required
length ≥ 1

The targetted application ids to send push messages to.

The tokens in these application ids in conjuction with tag filtering will be selected and used in sending.

This field is required.

applicationIds*
content
object

The content that will be sent to selected audience.

Note: Cannot be used together with multiLangContent.

multiLangContent
object

This field is used to send multi language content.

Note: Cannot be used together with content. Multi-language feature must be enabled in your account.

tagList
array of objects
required
length between 1 and 3

Tag list to filter audiences.

Required and cannot be empty. Maximum 3 tags allowed.

tagList*
string
required

Tag name to filter.

If value is not used, all audience with this tag will be selected.

string

Value for the tag selected in tag variable.

When used, audiences with this tag and value will be selected in the application ids

string
enum

AND or OR to join tags and values.

Required when multiple tags are provided.

Allowed:
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.

date-time

Schedule date for the push notification in UTC format.

Format: yyyy-MM-ddTHH:mm:ss.fffZ

sendingParams
object

Additional sending parameters

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

401

Unauthorized - Authentication is required.

404

Not Found - The template ID you have set was not found.

Updated 2 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago