v1

latestOpenAPI 3.0.02026-07-22266146.1 KB
campaign_mailings

Schedule a new campaign mailing

Schedules a new email campaign mailing with specified details for delivery at a future time

post/campaign_mailing_schedules

Request body

send_atstring date-time required

The time at which to send the campaign, in RFC3339 format

from_emailstring email required

The email address from which the campaign will be sent. It should be from a verified domain from your Paubox Marketing settings page

from_namestring required

The name to appear as the sender of the campaign

sender_emailstring email required

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_idstring uuid required

The uuid of the subscription list to which the campaign will be sent

subjectstring required

The subject line of the campaign mailing

dynamic_list_idstring uuid

The uuid of the dynamic list to which the campaign will be sent (optional)

recipient_emailsstring[]

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

Response

Campaign mailing scheduled successfully