Sign in
Campaigns

Create Campaign

Creates a new Campaign for the given site.

post/shop/customers/campaigns

Request body

site_idstring uuid required

The ID of the site this campaign belongs to.

namestring required

The display name of the campaign.

segment_idstring uuid

The ID of the CustomerSegment to send this campaign to. Required when provided.

Example request

{
  "name": "Summer Promotion 2024"
}

Response

The campaign was successfully retrieved.

Example response

{
  "data": {
    "name": "Summer Promotion 2024",
    "progress": 42.5,
    "segment": {
      "name": "Premium Members"
    },
    "status": "unsent"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.