Skip to content

Create Campaign

Creates a campaign — the Create Campaign action on the admin Marketing → Communications → Campaigns screen.

TIP

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

Endpoint

EndpointMethod
/api/admin/marketing/campaignsPOST

Details

  • Requires an admin Bearer token and the marketing.communications.campaigns.create permission.
  • Returns the full campaign payload, including the resolved channel, customerGroup, marketingTemplate, and marketingEvent objects (marketingEvent is null when no event is linked).
  • Creating a campaign does not send it — use the send endpoint to queue the email.

Request body

FieldTypeRequiredNotes
namestringyesCampaign name
subjectstringyesEmail subject line
marketing_template_idintyesEmail template to send
channel_idintyesChannel the campaign sends from
customer_group_idintyesCustomer group the campaign targets
marketing_event_idintnoLinked event, or null
statusintno0 inactive / 1 active

Released under the MIT License.