Skip to content
View as Markdown
Enter your site to enable Send. Requests are sent from your browser, so the site must allow cross-origin calls (CORS).

POST Update Single Campaign (Simulate)​

POST
/campaigns/update-single-campaign

Update a campaign using a POST request instead of PUT. This is a convenience endpoint that internally delegates to the campaign update logic. The campaign ID is passed in the request body rather than the URL path. Useful when method override is not available.

Required capability: fcrm_read_emails or fcrm_manage_emails — which one applies depends on the action being performed.

Enforced by CampaignPolicy::verifyRequest(), the policy default for this route group.

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)

Request Body​

application/json
JSON
{
"campaign_id": 0,
"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": [
{
}
],
"next_step": 0
}

Responses​

Campaign updated successfully.

application/json
JSON
{
"campaign": {
"id": 0,
"title": "string",
"slug": "string",
"status": "string",
"template_id": 0,
"email_subject": "string",
"email_pre_header": "string",
"email_body": "string",
"recipients_count": 0,
"design_template": "string",
"scheduled_at": "string",
"settings": {
},
"created_at": "string",
"updated_at": "string"
}
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI