docs
  1. Admin Api
  2. Resources
  3. Campaigns
  4. Create A New Campaign

Create a new campaign

Create a new campaign

Rate Limit: 300 Max attempts within 1 minute.

Path Parameters

ParameterDetails
shopKey
  • required
string
Example:
ms

Request body

required
ParameterDetails
id
  • readonly
integer
Example:
1
name
  • required
  • MinLength: 1
string
Example:
My Campaign
description
  • nullable
string
Example:
My first campaign.
countryCodes
  • required
string
Example:
DE,GB
reduction
  • Maximum: 99
number
Example:
10.45
startAt
  • required
string
Example:
2021-01-23T11%3A30%3A58%2B00%3A00
endAt
  • required
string
Example:
2021-09-23T11%3A30%3A58%2B00%3A00
campaignKey
  • MaxLength: 36
string
Example:
05f962c8-857b-462a-bea2-54e2bfecf729
customData
  • nullable
object
  • MinProps: 1

Responses

201
Campaign was successfully created.
application/json
Success
id
integer
Example:
1
namerequired
string
Example:
My Campaign
description
string
Example:
My first campaign.
countryCodesrequired
Array of string
reduction
number
Example:
10.45
startAtrequired
string
Example:
2021-01-23T11%3A30%3A58%2B00%3A00
endAtrequired
string
Example:
2021-09-23T11%3A30%3A58%2B00%3A00
campaignKey
string
Example:
05f962c8-857b-462a-bea2-54e2bfecf729
null
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
POST/shops/{shopKey}/campaigns

Request samples

Response samples

201
Campaign:
Content type: application/json
Provide Feedback