v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB
Coupons

Update a coupon

Updates an existing coupon's properties such as name, description, and metadata.

patch/api/v1/coupons/{id}

Path parameters

idstring required

The unique identifier of the entity

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

namestring

Name of the coupon

descriptionstring nullable

Description of the coupon

metadataobject nullable

Metadata associated with the entity

Response

The updated coupon object.