Campaign Mailings
Fetch campaign mailings
Return json data about Paubox 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:
Send campaign mailings
Send campaign email to recipients. The email message must be created within the Paubox Marketing web interface in order to use this to trigger a send.
URL
/campaign_mailing_sends
Method
POST
Data parameters
How to find your campaign_mailing_id and subscription_list_id in your Dashboard
Success Response
Code: 200
Content:
{}
Schedule a new campaign mailing
Schedules a new email campaign mailing with specified details for delivery at a future time.
URL
/campaign_mailing_schedules
Method
POST
Data Parameters
Required parameters must be included in the request body as JSON:
send_at
: The time at which to send the campaign, in RFC3339 format.from_email
: The email address from which the campaign will be sent. It should be from a verified domain from your Paubox Marketing settings page.from_name
: The name to appear as the sender of the campaign.sender_email
: The email address of the person/entity sending this email. Should be a Paubox user email address and is NOT going to appear as the From email.subscription_list_id
: The uuid of the subscription list to which the campaign will be sent.subject
: The subject line of the campaign mailing.
Optional:
dynamic_list_id
: The uuid of the dynamic list to which the campaign will be sent (optional).recipient_emails
: A list of extra recipient email addresses for the campaign to be sent to. These are not tracked for analytics purposes and are usually just for verification and/or testing.
Success Response
Code: 200
Content:
Error Response
Code: 400
Content: