/api/v1.0/{appId}/campaigns/retention/{campaignId}

Path Params
string
required
int32
required
Body Params
int32
1440 to 2147483647

Time in minutes, after which customer will receive retention voucher if he/she does not order

int32 | null
1 to 100

Discount amount in percents

double | null
≥ 0

Maximum discount for percentage discounts

double | null
0 to 2147483647

Discount amount in sum of money

int32
1 to 300

Number of days for which the voucher will be valid.

boolean

Discount will include delivery fee

boolean

Automatically apply resulting vouchers

boolean

Campaign will apply to existing orders

boolean

Is campaign enabled

StoreIds
array of int32s

Ids of stores this campaign applies to

StoreIds
string

The app that this campaign belongs to.

boolean

Controls whether the voucher generated from this campaign will override discount exclusions

Headers
string
enum
Defaults to application/json

Generated from available response content types

Responses

Language
Credentials
OAuth2
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
Data
Message
StackTrace