Update Email Campaign
PATCH/emails/locations/:locationId/campaigns/emails/:campaignId
Update an email campaign draft
Request
Version stringrequired
API Version
Available options
v3locationId stringrequired
Location ID
campaignId stringrequired
Campaign ID
- application/json
- Body
- Example (auto)
Bodyrequired
namestring
Campaign name
editorContentstring
Editor content to update. Required only when updating campaign content, and must be provided together with editorType. Provide HTML or plain-text string content.
editorTypestring
Editor type for campaign content. Required only when updating campaign content, and must be provided together with editorContent.
Available options
htmltextuserIdstring
ID of the user performing this action
{
"name": "Untitled campaign name",
"editorContent": "<html><body>Hello World</body></html>",
"editorType": "html",
"userId": "507f1f77bcf86cd799439011"
}
Success
- application/json
- Schema
- Example (auto)
Schema
idstringrequired
Campaign ID
sourcestring
Source of the campaign
sourceIdstring
Source ID of the campaign
namestring
Campaign name
statusstring
Campaign status
Available options
allsentfailedarchiveddraftprocessingscheduledcancelledpausedcampaignTypestring
Campaign type
campaignCategorystring
Campaign category
variationsobject[]
AB test variation identifiers (available only for AB test campaigns)
deletedbooleanrequired
Whether the campaign is deleted
createdAtstringrequired
Created at timestamp
updatedAtstringrequired
Last updated timestamp
traceIdstring
Trace ID of request
{
"id": "67f15c2ae99226d5bcccb8f3",
"source": "email-campaign",
"sourceId": "bulkRequest_abc123",
"name": "February Newsletter",
"status": "sent",
"campaignType": "bulk-email",
"campaignCategory": "email-campaign",
"variations": [
{
"sourceId": "9MhVcU7dTdLI7XOU1Vdt",
"isWinner": true
}
],
"deleted": false,
"createdAt": "2025-07-24T11:55:43.598Z",
"updatedAt": "2026-02-09T04:49:12.322Z",
"traceId": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
}