Sign in

v9

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

Create promotion

Creates a new promotion within the caller account. The promotion is always created inactive.

post/api/v1/promotions

Request body

codestring required
namestring required
descriptionstring nullable
metadataobject

Response

Promotion created.

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
metadataobject nullable required
created_atstring required
updated_atstring required