Skip to content
View as Markdown

PUT Update Campaign​

PUT
/campaigns/{id}

Update an existing campaign. Supports updating title, email content, UTM parameters, template, settings, and A/B test subjects. When next_step is provided, it advances the campaign wizard and performs step-specific validation (e.g., compliance checks for unsubscribe links on step 2).

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Path Parameters

id*

The campaign ID to update.

Type
integer
Required

Request Body​

application/json
JSON
{
"title": "string",
"slug": "string",
"template_id": 0,
"email_subject": "string",
"email_pre_header": "string",
"email_body": "string",
"utm_status": 0,
"utm_source": "string",
"utm_medium": "string",
"utm_campaign": "string",
"utm_term": "string",
"utm_content": "string",
"scheduled_at": "string",
"design_template": "string",
"settings": {
},
"update_subjects": true,
"subjects": [
{
"key": "string",
"value": "string"
}
],
"next_step": 0
}

Responses​

Campaign updated successfully.

application/json
JSON
{
"campaign": {
"id": 0,
"title": "string",
"status": "string",
"email_subject": "string",
"email_pre_header": "string",
"email_body": "string",
"design_template": "string",
"settings": {
},
"subjects": [
{
}
],
"created_at": "string",
"updated_at": "string"
}
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI