Skip to content

Update Campaign ​

Updates an existing campaign — the Edit Campaign action on the admin Marketing → Communications → Campaigns screen.

New here? Read the Campaigns overview for what a campaign does and how its fields behave.

Endpoint ​

EndpointMethod
/api/admin/marketing/campaigns/{id}PUT

Details ​

  • Requires an admin Bearer token and the marketing.communications.campaigns.edit permission.
  • The update is a partial merge — send only the fields you want to change; omitted fields keep their existing values.
  • Returns the full updated campaign payload, including the resolved channel, customerGroup, marketingTemplate, and marketingEvent objects (marketingEvent is null when no event is linked).

Request body ​

FieldTypeRequiredNotes
namestringnoCampaign name
subjectstringnoEmail subject line
marketing_template_idintnoEmail template to send
channel_idintnoChannel the campaign sends from
customer_group_idintnoCustomer group the campaign targets
marketing_event_idintnoLinked event, or null
statusintno0 inactive / 1 active

Released under the MIT License.