promotionCodes

Archive a promotion code

Requires the PROMOTION_CODE.STATUS.UPDATE permission.

post/v{version}/promotion-codes/{resourceIdOrReference}/archive

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/promotion-codes/{resourceIdOrReference}/archive
  • 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.

Response

OK

object_typestring nullable
idstring nullable
code_formatstring
codestring
coupon_idstring
status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'ARCHIVED' | 'DEPRECATED'
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.