Email campaigns API allows you to send emails / smses to a specific group created through Create group method or through the panel.
Use this method to send emails to a group of contacts created through endpoint Create group method.
The unique ID of the campaign.
first-campaign-idPattern: /^[a-zA-Z-_]+$/The name of the campaign.
firstCampaignThe description of the campaign.
My first campaignThe subject of the message in the campaign.
Hello worldThe name of the sender.
John DoeThe email address of the sender.
john.doe@example.plThe email address to reply to.
john.doe@example.plThe URL of the website.
The html of the message.
<h1> hello there</h1>The text of the message.
hello there!The externalId of the group the message will be sent to. This ID can be found using List group method.
test-group-idThe URL shortener and tracker. Setting this property to ‘true’ will make the urls shorter and also urls will be tracked.
trueThe optional campaign tracking parameter provided by Google Analytics.
trueThe date the message will be set off. Be aware that if the campaign is going to be sent to many of recipients (thousands and more) the schedule date means then preparing all contacts firstly and then sending. For example, there is a campaign scheduled for 2020-01-01 10:00:00 so at 10 o'clock our system will start to collect all contacts from chosen group which can take sometimes more than an hour and then the messages will be sent to recipients.
2020-09-10 10:15:00Pattern: /^\d{4}-\d{2}-\d{2}\s*(?:\d{2}:\d{2}(?::\d{2})?)?$/If set to 'editable' allows to prevent sending email campaign immediately after creation
editableExample: editablePossible values: The email addresses to send the campaign to see if the message is ok.
john.doe@example.plThe email addresses to send info about campaign end.
john.doe@example.plUse this method to get details of email clicks from a certain date range. Please remember clicks are stored for 90 days.
Id of existing campaign
The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.
100The number of items omitted from the beginning of the list. Default ‘0’.
0Start of the time range.
2025-01-01 00:00:00End of the time range.
2025-01-03 00:00:00Use this method to list all campaigns and its details from a certain time range.
The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.
100The number of items omitted from the beginning of the list. Default ‘0’.
0Start of the time range.
2025-01-01 00:00:00End of the time range.
2025-01-03 00:00:00Use this method to get details of email opens from a certain date range. Please remember opens are stored for 90 days.
Id of existing campaign
The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.
100The number of items omitted from the beginning of the list. Default ‘0’.
0Start of the time range.
2025-01-01 00:00:00End of the time range.
2025-01-03 00:00:00Use this method to get all recipients from the email campaign. You can filter recipients who have got bounce states as well.
Search with campaign external ID. The search by campaignId does not work in conjunction with the date search. These two search options are incompatible and must be used separately.
6F8EB428-0917-4DE7-BE1D-ACCD7432A4B8If true then action will return only bounced recipients
Search with date (UTC timezone). The search by date does not work in conjunction with the search by campaignId. These two search options are incompatible and must be used separately.
2025-01-03 00:00:00Pattern: /(^\d{4}-\d{2}-\d{2})\s(\d{2}:\d{2}:\d{2})$/Search with date (UTC timezone). The search by date does not work in conjunction with the search by campaignId. These two search options are incompatible and must be used separately.
2025-01-01 00:00:00Pattern: /(^\d{4}-\d{2}-\d{2})\s(\d{2}:\d{2}:\d{2})$/The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.
100The number of items omitted from the beginning of the list. Default ‘0’.
0Use this method to get date of a click on unsubscribe link and the email address of the unsubscribed.
Id of existing campaign
The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.
100The number of items omitted from the beginning of the list. Default ‘0’.
0Start of the time range.
2025-01-01 00:00:00End of the time range.
2025-01-03 00:00:00Use this method to list all campaigns and its details from a certain time range.
The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.
100The number of items omitted from the beginning of the list. Default ‘0’.
0Start of the time range.
2025-01-01 00:00:00End of the time range.
2025-01-03 00:00:00Use this method if you want to change the status of an already prepared or launched campaign. You can only start or cancel campaign. Each campaign gets statuses like editing, redytosend, sending and sent. If you cancel campaign that have sending state it will get sent state.
Id of existing campaign
sendablePossible values: The date the message will be set off. Be aware that if the campaign is going to be sent to many of recipients (thousands and more) the schedule date means then preparing all contacts firstly and then sending. For example, there is a campaign scheduled for 2020-01-01 10:00:00 so at 10 o'clock our system will start to collect all contacts from chosen group which can take sometimes more than an hour and then the messages will be sent to recipients.
2020-09-10 10:15:00Pattern: /^\d{4}-\d{2}-\d{2}\s*(?:\d{2}:\d{2}(?::\d{2})?)?$/The email addresses to send the campaign to see if the message is ok.
john.doe@example.plUse this method to get all details of certain email campaign such as subject, fromAddress, groupId, scheduleTime and more.
Id of existing campaign
Use this method to get all details of certain SMS campaign such as campaignId, senderId, message, scheduleTime and more.
Id of existing campaign
Use this method to get details of SMS clicks from a certain date range. Please remember clicks are stored for 90 days.
Id of existing campaign
The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.
100The number of items omitted from the beginning of the list. Default ‘0’.
0Start of the time range.
2025-01-01 00:00:00End of the time range.
2025-01-03 00:00:00Use this method to list all campaigns and its details from a certain time range.
The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.
100The number of items omitted from the beginning of the list. Default ‘0’.
0Start of the time range.
2025-01-01 00:00:00End of the time range.
2025-01-03 00:00:00Use this method to get all recipients details from SMS campaign. Possible SMS status values: SMS_SEND, SMS_ERROR, SMS_WAITING, SMS_CANCELED, SMS_BAD_NUMBER, SMS_MESSAGE_TOO_LONG, SMS_MESSAGE_INCORRECT, SMS_MESSAGE_TOO_SHORT, SMS_UNKNOWN_ERROR
Id of existing campaign
The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.
100The number of items omitted from the beginning of the list. Default ‘0’.
0Use this method to get sms campaign state. Available values: editing, readytosend, sending, sent and deliveredtosend.
Id of existing campaign