Skip to main content
POST
/
channels
/
{myshopifyDomain}
/
campaigns
Create Channel Campaign
curl --request POST \
  --url https://unified-api.creatorcommerce.shop/channels/{myshopifyDomain}/campaigns \
  --header 'Content-Type: application/json' \
  --header 'x-channel-access-token: <api-key>' \
  --data '
{
  "title": "Default Campaign",
  "description": "Always-on campaign",
  "isActive": true,
  "collabTiers": [
    "6997d1305fe142fd13cff500"
  ],
  "queryParams": "utm_source=creatorcommerce&utm_medium=affiliate",
  "tags": [
    "default",
    "evergreen"
  ]
}
'
{
  "campaign": {
    "_id": "699752d110aaf04ada0eb4ef",
    "title": "Default Campaign",
    "description": "Always-on campaign",
    "isActive": true,
    "collabTiers": [
      "6997d1305fe142fd13cff500"
    ],
    "queryParams": "utm_source=creatorcommerce&utm_medium=affiliate"
  }
}

Authorizations

​
x-channel-access-token
string
header
required

Channel or partner access token (x-channel-access-token or x-partner-access-token)

Path Parameters

​
myshopifyDomain
string
required

Body

application/json
​
_id
string
​
title
string
​
collabTiers
string[]
​
brandPage
string | null
​
productPage
string | null
​
channel
string
​
isActive
boolean
​
brandPageRedirectUrlTemplate
string
​
productPageRedirectUrlTemplate
string
​
queryParams
string
​
tags
string[]
​
startedAt
string<date-time>
​
createdAt
string<date-time>
​
updatedAt
string<date-time>

Response

Campaign created

​
campaign
object
required