Campaign Mailings


Fetch campaign mailings

Return json data about Marketing Campaign Emails

URL

/campaign_mailings

Method

GET

Data parameters

Optional:

search=[string] Regex string to search on. Compares against subject.

order_by[attribute] Attribute to sort on. Default value is created_at.

order=[asc | desc] Direction to sort. Default value is descending.

Success Response

Code: 200
Content:

{
"data": [
{
"id": "string",
"type": "campaign_mailing",
"attributes": {
"subject": "string",
"created_at": "string",
"updated_at": "string",
"sent_count": "integer",
"delivered_count": "integer",
"viewed_count": "integer",
"clicked_count": "integer",
"bounced_count": "integer",
"unsubscribed_count": "integer"
}
},
]
}

Send campaign mailings

Send campaign email to recipients.

URL

/campaign_mailing_sends

Method

POST

Data parameters

{
"campaign_mailing_id" : "integer", //required
"campaign_mailing_send" : {
"sender_email" : "string", //required - email must be within the valid sender_domains
"subscription_list_id" : "string", //required if 'recipient_emails' is empty else optional
"recipient_list" : ["string"], //required if 'subscription_list_id' is empty else optional
"customer_name" : "string", //optional
"from_email" : "string", //optional
"from_name" : "string", //optional
"subject" : "string", //optional
}
}

Optional:

search=[string] Regex string to search on. Compares against subject or sender_email.

order_by[attribute] Attribute to sort on. Default value is created_at.

order=[asc | desc] Direction to sort. Default value is descending.

Success Response

Code: 200
Content:

{}