Update unique catalog offer promotion

Update unique catalog offer promotionServer-sideAdmin

put/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}

Updates the unique catalog offer promotion.

SecuritybasicAuth

Request

path Parameters

project_id required	integer Project ID. You can find this parameter in your Publisher Account next to the name of the project. Example: 44056
external_id required	integer Promotion external ID. Unique promotion identifier within the project. Example: coupon_44056_1

Request Body schema: application/json

required

object

Default: {"en-US":"Coupon title","de-DE":"Gutscheintitel"}

Name of promotion. Should contain key/value pairs where key is a locale with "^[a-z]{2}-[A-Z]{2}$" format, value is string.

property name*

additional property

string

Array of objects

Promotion validity periods. If multiple periods are specified, both date_from and date_until are required.

Array

date_from required	string <date-time> Start date for the specified promotion.
date_until	string or null <date-time> End date for the specified promotion. If set to `null`, the promotion is indefinite. Can be `null` only if a single validity period is specified.

items

Array of strings

A list of items SKU that are available after using the unique catalog offer.

redeem_total_limit

integer or null

Default: 10

Limits total numbers of coupons.

redeem_user_limit

integer or null

Default: 10

Limits total numbers of coupons redeemed by single user.

redeem_code_limit

integer or null

Default: 10

Number of redemptions per code.

Responses

204

Unique catalog offer was successfully updated.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

404

Coupon not found. Make sure the external_id is correct.

422

Invalid request.

Request samples

application/json

{"promotion_periods": [{"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
},
{"date_from": "2020-05-15T18:16:00+05:00",
"date_until": "2020-05-25T18:16:00+05:00"
}
],
"name": {"en-US": "New Year Offer",
"de-DE": "Neujahrsangebot"
},
"items": ["elven_sword",
"elven_boots"
]
}

Response samples

application/json

{"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}