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-id"/^[a-zA-Z-_]+$/The name of the campaign.
"firstCampaign"The description of the campaign.
"My first campaign"The subject of the message in the campaign.
"Hello world"The name of the sender.
"John Doe"The email address of the sender.
"john.doe@example.pl"The email address to reply to.
"john.doe@example.pl"The 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-id"The 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:00"/^\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
"editable"The email addresses to send the campaign to see if the message is ok.
The email addresses to send info about campaign end.
Request was successfully processed
Additional data
Use 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
"sendable"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:00"/^\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.
Request was successfully processed
Additional data