Skip to content

Create Campaign ​

Creates a campaign — the Create Campaign action on the admin Marketing → Communications → Campaigns screen. A campaign pairs an email template with a recipient customer group for a channel.

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

Operation ​

OperationTypePurpose
createAdminMarketingCampaignMutationCreate a campaign

Details ​

  • Requires an admin Bearer token and the marketing.communications.campaigns.create permission.
  • 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
nameStringYesCampaign name
subjectStringYesEmail subject line
marketingTemplateIdIntYesEmail template to send
channelIdIntYesChannel the campaign sends in
customerGroupIdIntYesRecipient customer group
marketingEventIdIntNoOptional linked event, or null
statusIntNo0 inactive / 1 active

Released under the MIT License.