j
Transactional Messaging - OTT
1.0
Overview
Use the transactional messaging for OTT (over-the-top) endpoint to send immediate, automated, and high-performance transactional messages. Transactional messages may include order confirmation messages, password reset emails, and bank balance inquiry messages.
Note: The transactional messaging for OTT endpoint is supported for Unified Messaging and WhatsApp Direct.
Base URI
https://{YOUR_SUBDOMAIN}.rest.marketingcloudapis.com/
In the base URI example, replace {YOUR_SUBDOMAIN} with your service's "sub domain". For more information, see Tenant-Specific API Endpoints.
Prerequisites
Before using the transactional messaging for OTT APIs, ensure that you:
- Set up your WhatsApp Account in Marketing Cloud.
- Create a WhatsApp template message for approval in Marketing Cloud.
- Set up Installed Packages to create an API integration and get a client ID and client secret. Remember to assign the appropriate scopes for the package. For more information, see API Integration Permission Scopes.
Supported Use Cases
| Supported Use Case | HTTP Verb | URI |
|---|---|---|
| Get all send definitions | GET | /messaging/v1/ott/definitions/ |
| Create a send definition | POST | /messaging/v1/ott/definitions/ |
| Get a send definition by key | GET | /messaging/v1/ott/definitions/{definitionKey} |
| Update a definition | PATCH | /messaging/v1/ott/definitions/{definitionKey} |
| Delete a definition | DELETE | /messaging/v1/ott/definitions/{definitionKey} |
| Sends a message to multiple recipients using a send definition | POST | /messaging/v1/ott/messages/ |
| Get message send status for recipient | GET | /messaging/v1/ott/messages/{messageKey} |
DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!