Error

A valid request URL is required to generate request examples

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

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Assign card definition to 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.

Assigns a single card definition to the program. The program must be in DRAFT status - otherwise the request is rejected with 423 Locked (key non_draft_program). Returns 409 Conflict when the assignment already exists.

POST

loyalties

programs

{programId}

card-definitions

Assign card definition to program

curl --request POST \
  --url {protocol}://{host}/v2/loyalties/programs/{programId}/card-definitions \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "id": "<string>"
}
'

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

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Path Parameters

string

required

Unique program identifier.

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

Body

application/json

Card definition to assign to the program.

string

required

Unique card definition identifier.

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

Response

Card definition assignment created.

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"

Last modified on August 3, 2026

⌘I

Introduction

Endpoints

Events

Assign card definition to program

Authorizations

Path Parameters

Body

Response