Skip to content

Update Campaign ​

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

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

Operation ​

OperationTypePurpose
updateAdminMarketingCampaignMutationUpdate a campaign

Details ​

  • Requires an admin Bearer token and the marketing.communications.campaigns.edit permission.
  • Pass the campaign's IRI as id. The update is a partial merge — send only the fields you want to change; omitted fields keep their existing values.
  • The mutation returns the campaign's scalar fields. The channel, customerGroup, and marketingTemplate objects do not resolve on the mutation payload — re-query the detail to read them.

Input fields ​

FieldTypeRequiredNotes
idIDYesThe campaign's IRI
nameStringNoCampaign name
subjectStringNoEmail subject line
marketingTemplateIdIntNoEmail template to send
channelIdIntNoChannel the campaign sends in
customerGroupIdIntNoRecipient customer group
marketingEventIdIntNoLinked event, or null
statusIntNo0 inactive / 1 active

Released under the MIT License.