A valid request URL is required to generate request examples{
"_id": "<string>",
"cancelledAt": "<string>",
"createdAt": "<string>",
"editorType": "unlayer",
"failedCount": 123,
"from": "<string>",
"hostedUrl": "<string>",
"name": "<string>",
"plainTextBody": "Hello, world! This is a plaintext version of the email without any HTML formatting.",
"previewImageUrl": "<string>",
"previewText": "<string>",
"scheduledAt": "<string>",
"sentCount": 123,
"status": "<string>",
"subStatus": "missing_billing_info",
"subject": "<string>",
"totalRecipients": 123,
"updatedAt": "<string>"
}Add a campaign
A valid request URL is required to generate request examples{
"_id": "<string>",
"cancelledAt": "<string>",
"createdAt": "<string>",
"editorType": "unlayer",
"failedCount": 123,
"from": "<string>",
"hostedUrl": "<string>",
"name": "<string>",
"plainTextBody": "Hello, world! This is a plaintext version of the email without any HTML formatting.",
"previewImageUrl": "<string>",
"previewText": "<string>",
"scheduledAt": "<string>",
"sentCount": 123,
"status": "<string>",
"subStatus": "missing_billing_info",
"subject": "<string>",
"totalRecipients": 123,
"updatedAt": "<string>"
}Authorizations
API key authentication
Response
Successfully created
Id of the campaign
Timestamp when the campaign was cancelled or failed
Date and time of creation
Which editor produced the campaign body. Campaigns created before the editor choice existed read back as 'unlayer'.
unlayer, code Failed sent count
From email address
Public URL of the campaign's hosted copy. Always present; null unless the campaign sent successfully and its hosted artifact was stored.
Name of the campaign
Plaintext version of the email body without HTML formatting
"Hello, world! This is a plaintext version of the email without any HTML formatting."
URL of the last thumbnail that finished rendering. The thumbnail is rendered after the response is sent, so this value may lag a content-changing write and is absent on a freshly created campaign.
Preview text of the email
Date and time of scheduled email
Successfully sent count
Status of the campaign
Granular failure/cancellation reason. Null for non-failure states or legacy campaigns.
missing_billing_info, account_suspended, invalid_subscription, system_error, quota_exceeded, circuit_breaker_bounce, circuit_breaker_complaint, circuit_breaker_combined, rejected_automated_review, rejected_manual_review, null Subject of the email
Contacts this campaign is expected to email. 0 until the campaign is scheduled (except for an explicit contact-list audience, counted at creation), then estimated from the audience; narrows to the mailable (active) population when the send begins — the figure the sending-allowance decision uses.
Date and time of last update