To create a new campaign of event-triggered message, you can use the POST
method in our API.
Request Body
Currently, you can create an event-triggered SMS, MMS, or push notification.
In the body of your request, you’ll include an event-triggered campaign entity that represents the event-triggered message campaign you are trying to create.
Personalize your MMS
If you’d like to add personalized images to your MMS sends, you can do so by including the
media_url
in your event payload. In your event-triggered campaign request body, you would include a liquid template variable such as{{ ev.media_url }}
in place of themedia_url
.
Filtering by subscription list
If you would like to only send to certain subscription lists, you can use the filter
array below. Here are the steps to filter by list:
- Expand the
targeting
object. - Scroll down to
filters
. - Set the
name
string to `subscription’. - Set the
selector
string toany
. - Under
values
select CHOOSE IF FILTERING BY SUBSCRIPTION LIST and enter the subscription list id. - If you are using multiple lists, choose ADD+ to add another subscription list (outlined in green below).
See below for an example:
Response
If you have successfully created an event-triggered message campaign using the POST
method, you will receive a 202 – CREATED
status code. In additional, you will receive a return will include additional information about your new campaign, including the event_triggered_messsage_id
, status
, created_by
, and more. These are defined by the system and cannot be changed.