Sign in
Campaigns

Update Campaign

Updates the given Campaign.

put/shop/customers/campaigns/{campaignId}

Request body

namestring

The display name of the campaign.

segment_idstring uuid nullable

The ID of the CustomerSegment to send this campaign to. Pass null to remove the assigned segment.

scheduled_atstring date-time nullable

The datetime at which this campaign should be sent. Pass null to unschedule the campaign.

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.