post

/merchants/{merchant_id}/coupon_promotions

Create a new coupon campaign.

Deprecated

Avoid using this API operation if possible. It will be removed in a future version.

Authorization

basic

Request Parameters

1 Path Parameter

Request Body

1 Example
Schema
object
$schema: http://json-schema.org/draft-04/schema#
campaign_code
string

Campaign name.

required
project_id
integer

Project ID.

required
campaign_names
object

Object containing localized campaign names.

required
expiration_date
string

Campaign expiration date in the YYYY-MM-DD’T’HH:MM:SS format per ISO 8601.

1 validation
virtual_currency_amount
number

Virtual currency amount in a reward.

3 validations
virtual_items
object

Array of virtual items parameters in a reward.

subscription_coupon
object

Object containing subscription parameters in a reward.

redeems_count
integer

Maximum number of coupon redeems. If null is passed, the redeems number is unlimited.

redeems_count_for_user
integer

Maximum number of coupon redeems per user. If null is passed, the redeems number is unlimited.

campaign_redeems_count_for_user
integer

Maximum number of coupon redeems per user within a campaign. If null is passed, the redeems number is unlimited.

Responses

Created

Schema
object
$schema: http://json-schema.org/draft-04/schema#
id
integer
1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
merchant_id
$$.env
2 variables not set
username
password