SendTransactionalWhatsapp

The SendTransactionalWhatsapp function sends transactional WhatsApp messages to recipients.

You must use your own partnerId (which you can find in the dEngage Panel > Instant Message Partner Details page) along with the payload to send messages.

One important note: you can send only one message to a single recipient at a time.

If the components required for the specified WhatsApp message template (templateName and languageCode) are not provided, the request will return a successful response, but the message will fail to send.

Language Selection Logic for WhatsApp REST API

When sending WhatsApp messages via REST API, multi-language template support is now available. The system determines which template to send by following this order of checks:

1. Request-level languageCode

If languageCode is provided in the request and a template exists in that language, that template is used.

2. Recipient’s language

If no matching template is found for the request’s languageCode, the system checks the recipient’s language.

If a template exists in the recipient’s language, it will be used.

3. Account-level language

If no recipient language match is found, the system checks the account’s default language.

If a matching template exists for the account language, it is used.

4. Fallback to default template

If none of the above provide a match, the system falls back to the first available template in the list.


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

Body Params
integer
required

This is the ID provided by Dengage once the configuration is completed. You can retrieve it from the Configuration screen after clicking the Add Account button.

payload
object
required

payload object to send whatsapp message

tags
array of strings

tags are optional

tags
Headers
string
Defaults to {$$.env.access_token}
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

429

Too Many Requests

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