coupons

Update a coupon

Requires the COUPON.UPDATE permission.

patch/v{version}/coupons/{resourceIdOrReference}

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/coupons/{resourceIdOrReference}
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdOrReferencestring required

The ID or reference of the resource.

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
namestring
referencestring
descriptionstring nullable
status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'DEPRECATED' | 'ARCHIVED'
start_atstring nullable
end_atstring nullable
maximum_redemptionsinteger nullable
number_of_redemptionsinteger nullable
created_atstring nullable
updated_atstring nullable

Response

OK

object_typestring nullable
idstring nullable
namestring
referencestring
descriptionstring nullable
status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'DEPRECATED' | 'ARCHIVED'
start_atstring nullable
end_atstring nullable
maximum_redemptionsinteger nullable
number_of_redemptionsinteger nullable
created_atstring nullable
updated_atstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.