v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Update a Redemption Key by Code

This endpoint can be used by a backend integrator to patch the redemption key resource, or used to redeem a code using a user level access token.

patch/redemption-keys-by-code/{client_id}/{code}/

Path parameters

client_idstring required

the client_id

codestring required

the code belonging to the redemption key

Request body

statusstring

valid values are "active", "inactive", "redeemed"

Response

200

idstring

client_idstring

namestring

descriptionstring

codestring

statusstring

created_atstring

redeemed_atstring

redeemed_bystring

Example response

{
  "id": "34c902c4-91df-4f9f-abe6-4fdaf1a6a8d0",
  "client_id": "FVQI5U57tfCyDV99YjhF3ExdlpiObg5JASvy81Mu",
  "name": "Integrators Redemption Code",
  "description": "uu",
  "code": "234JNHJF242FG",
  "status": "redeemed",
  "created_at": "2022-02-01T16:38:44.781943Z",
  "redeemed_at": "2022-02-01T16:46:18.132788Z",
  "redeemed_by": "d453e168-ee8d-49e8-b78e-f440d1673e6f"
}