v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01934981.1 MB
Card Definitions

Update Card Definition

<Warning>

<Badge color="yellow">BETA endpoint</Badge>

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

</Warning>

Updates a card definition. All properties are optional; only provided sections are updated. type and status cannot be changed through this endpoint (status transitions are performed via the activate/draft endpoints).

When the card definition is in use (e.g. assigned to a program with existing cards), updates to restricted sections may be rejected with a resource-locked error; only name, metadata and pay_with_points are always updatable.

put/v2/loyalties/card-definitions/{cardDefinitionId}

Path parameters

idstring required

Unique card definition ID. Pattern: ^lcdef_[a-f0-9]+$.

Request body

namestring nullable

Card definition name.

metadataobject nullable

Arbitrary key-value metadata attached to the card definition.

Response

The updated card definition.

idstring required

Unique card definition ID.

namestring required

Card definition name.

type'INDIVIDUAL' required

Card definition type.

status'DRAFT' | 'ACTIVE' | 'DELETED' required

Current card definition status.

metadataobject required

Arbitrary key-value metadata. Empty object when not set.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time nullable required

Last update timestamp (ISO 8601). Null when the card definition has never been updated.

object'card_definition' required

Object type marker. Always card_definition.