Update a promotion code

patch

https://partner-api.monta.com/api/v1/promotion-codes/{id}

Required scope: promotion-codes:write
Organization authorization: supported

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Body Params

name

string | null

Name of the promotion code

code

string | null

^[a-z0-9]+(?:-[a-z0-9]+)*$

Unique code string. Cannot be changed once used. Must be lowercase alphanumeric, optionally hyphen-separated.

description

string | null

Description of the promotion code

amount

double | null

0.1 to 100

Discount amount or percentage. Cannot be changed once the code has been used.

maxUsesCount

int32 | null

≥ 1

Maximum number of times the code can be used

startAt

date-time | null

When the promotion code becomes active (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

endAt

date-time | null

When the promotion code expires (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

maxDiscountAmount

number | null

0.01 to 999999.99

Max total discount this code can apply. Once the cap is reached, code becomes unusable. Omit to leave unchanged.

selectedTeamIds

array of int64s | null

Team IDs the promotion code is restricted to. Pass an empty array to clear restrictions.

selectedTeamIds

maxChargeUsesCount

int32 | null

1 to 10000

Max charges per driver eligible for the discount after redeeming. Omit to leave unchanged.

Responses

200Promotion code updated

400The request is invalid

401Consumer with provided credentials was not found

403Operator doesn't have access to resource

404Entity with the provided id was not found