Update Campaign
Patch a draft campaign.
MethodPATCH
/api/v2/campaigns/:campaignIdPatches a draft campaign. Permission: campaigns.
Path Parameters
| Name | Type | Description |
|---|---|---|
campaignId | string | Required. Campaign id. |
Body Parameters
| Name | Type | Description |
|---|---|---|
subject | string | Email subject line. |
name | string | Campaign name. Max 100. |
preview | string or null | Preview / preheader text. |
content | unknown | Replacement body. MAILY: TipTap JSON. HTML: raw HTML string. Switching format requires contentType plus matching content. |
contentType | "MAILY" | "HTML" | Target format. Metadata-only updates never switch format. |
senderId | string | Email sender id. |
replyTo | string or null | Reply-To address. |
All fields optional. Omit a field to leave it unchanged. A format switch requires contentType and a matching replacement body:
{
"id": "cmp_REPLACE_WITH_REAL_ID",
"contentType": "HTML",
"content": "<p>Updated email</p><p><a href=\"{{unsubscribeUrl}}\">Unsubscribe</a></p>"
}Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Campaign id. |
name | string | Campaign name. |
subject | string | Subject line. |
preview | string or null | Preview text. |
status | string | Campaign status. |
contentType | string | Content format. |
senderId | string | Sender id. |
replyTo | string or null | Reply-To address. |
updatedFields | string[] | Fields that changed. |
warnings | string[] | Present when a field was ignored or remapped. |
Errors
| Status | name | When |
|---|---|---|
| 401 | missing_api_key | Missing or invalid bearer token |
| 403 | missing_permission | Token lacks the campaigns permission |
| 404 | not_found | Unknown campaign id |
| 422 | validation_error | Invalid payload or campaign is not a draft |