Error
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>"
}email-campaign
Update campaign by id
PATCH
/
api
/
email
/
campaign
/
{campaignId}
Error
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>"
}Response
Successfully updated
Granular failure/cancellation reason. Null for non-failure states or legacy campaigns.
Available options:
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 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.