Create a new campaign
Create a new campaign
Rate Limit: 300 Max attempts within 1 minute.
Path Parameters
Parameter | Details |
---|---|
shopKey
| string Example: ms |
Request body
requiredParameter | Details |
---|---|
id
| integer Example: 1 |
name
| string Example: My Campaign |
description
| string Example: My first campaign. |
countryCodes
| string Example: DE,GB |
reduction
| number Example: 10.45 |
startAt
| string Example: 2021-01-23T11%3A30%3A58%2B00%3A00 |
endAt
| string Example: 2021-09-23T11%3A30%3A58%2B00%3A00 |
campaignKey
| string Example: 05f962c8-857b-462a-bea2-54e2bfecf729 |
customData
| object
|
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
Request samples
Response samples
201Campaign:
Content type: application/json