Unassign card definition from program

Documentation in progress

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

Unassigns a card definition from the program. The program must be in DRAFT status - otherwise the request is rejected with 423 Locked (key non_draft_program). Returns 423 Locked when the card definition is still referenced by an earning rule, reward, or tier structure assigned to the program.

DELETE /v2/loyalties/programs/{programId}/card-definitions/{cardDefinitionId}

Unassign card definition from program

cURL

curl --request DELETE \
  --url {protocol}://{host}/v2/loyalties/programs/{programId}/card-definitions/{cardDefinitionId} \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "card_type": "INDIVIDUAL",
  "card_definition_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "object": "<string>"
}

Authorizations

X-App-Id & X-App-TokenbearerAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

programId · string · required

Unique program identifier.

Pattern: ^lprg_[a-f0-9]+$

cardDefinitionId · string · required

Unique card definition identifier to unassign from the program.

Pattern: ^lcdef_[a-f0-9]+$

Response

200

application/json

Card definition assignment removed.

A card definition assigned to a program.

card_type · enum<string>

Card type of the assigned card definition.

Available options: INDIVIDUAL

card_definition_id · string

Unique card definition identifier.

Pattern: ^lcdef_[a-f0-9]+$

created_at · string<date-time>

Assignment creation timestamp (ISO 8601).

object · string

Object type marker.

Allowed value: "program_card_definition"