Sign in

v9

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-071292691.1 MB
promotions

Update promotion

Partially updates a promotion by its identifier. The code is immutable. Editing content is blocked while the promotion is active and in effect; toggling "active" is always allowed.

patch/api/v1/promotions/{id}

Path parameters

idstring uuid required
Example:01920000-0000-7000-8000-000000000000

Promotion identifier (UUID).

Request body

namestring
descriptionstring nullable
activeboolean
metadataobject nullable

Response

Promotion updated.

metadataobject nullable required
idstring required
codestring required
namestring required
descriptionstring nullable required
activeboolean required
validityobject required
eligibilityobject required
benefitobject required
item_restrictionsobject[] required
conditionsobject[] required
usage_limitsobject required
accumulationobject required
created_atstring required
updated_atstring required