Transactional Messaging API Quick Start
-
For transactional emails:
- In Content Builder, create the email message content to send.
- In Email Studio, apply the recipient details to all subscribers.
-
For transactional SMS:
- In MobileConnect, set up a keyword for your transactional short code.
-
In Installed Packages, create an API integration to get a client ID and client secret. Use the following email permissions settings for the API integration: write, read, and send. Use the following SMS permissions settings for the API integration: write, read, and send.
Never hard code client IDs or secrets in client side applications.
To save the attributes sent in the API request, create a triggered send data extension in Email Studio.
- Obtain access credentials. You can create server-to-server integrations and integrations with web and public apps. To authenticate all your API requests, use an access token. You can reuse the access token for multiple requests before it expires.
- Set up a transactional email send definition. The send definition contains the message template and delivery configuration. Each request to send a transactional email message must include a reference to a send definition.
- Send transactional email messages to one or more recipients.
- Create an optional subscription. A subscription uses a webhook to send you message analytics in real time. Analytics data includes information about sends and bounces.
- Obtain access credentials. You can create server-to-server integrations or integrations with web and public apps. To authenticate all your API requests, use an access token. You can reuse the access token for multiple requests before it expires.
- Set up a transactional SMS send definition. The send definition contains the message template and delivery configuration. Set up a definition for each messaging use case. For example, create one send definition for two-factor authentication messages and a separate one for order confirmations. Each request to send a transactional SMS message must include a reference to a send definition.
- Send transactional SMS messages to one or more recipients.
- Create an optional subscription. A subscription uses a webhook to send you message analytics in real time. Analytics data includes information about which messages were sent or not sent.