Sign in

v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01934981.1 MB
Programs

Create a program member

<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>

Enrolls a customer as a member of the loyalty program. The program must be in ACTIVE status (423 otherwise) and the customer must exist. A customer can be a member of a given program only once - creating a second member for the same customer returns 409 (member_already_exists).

Loyalty cards are created automatically for all card definitions assigned to the program and returned in the cards array. Card code generation is asynchronous - code may be null immediately after creation.

post/v2/loyalties/programs/{programId}/members

Path parameters

programIdstring required

Loyalty program ID (format lprg_[a-f0-9]+).

Request body

customer_idstring required

ID of an existing customer to enroll as a member. Required.

status'ACTIVE' | 'INACTIVE' nullable

Initial member status. Defaults to ACTIVE when omitted or null.

metadataobject nullable

Free-form metadata attached to the member. Validated against the metadata schema defined for the vl_member related object (when one is configured). Defaults to an empty object.

Response

The created member with its automatically created cards.

idstring required

Unique member ID assigned by Voucherify.

customer_idstring required

Unique Voucherify ID of the customer enrolled as this member.

program_idstring required

Unique Voucherify ID of the loyalty program the member belongs to.

status'ACTIVE' | 'INACTIVE' | 'DELETED' required

Current member status. INACTIVE member can't earn points or redeem rewards.

metadataobject required

Free-form metadata attached to the member (empty object when none).

created_atstring date-time required

Timestamp when the member was created (ISO 8601).

updated_atstring date-time nullable required

Timestamp when the member was last updated (ISO 8601), or null if never updated.

object'member' required

Object type marker, always member.