Programs

Create program member

Changed on

Enrolls an existing customer as a member of the loyalty program and creates a loyalty card for each card definition assigned to the program. Card code generation is asynchronous, so code can be null right after creation.

The program must be ACTIVE and inside its validity window, and the customer must already exist. A customer can be a member of a program only once. Identify the customer with customer_identification. status defaults to ACTIVE.

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

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/programs/{programId}/members
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or HTTP bearer

Request body

status'ACTIVE' | 'INACTIVE' nullable

Sets the initial member status. Allowed values are ACTIVE and INACTIVE. Defaults to ACTIVE when omitted or null.

metadataobject nullable

Stores custom metadata on the member. Validated against the metadata schema for the vl_member related object when one is configured. Defaults to an empty object when omitted or null.

Response

The created member with its automatically created cards.

idstring required

Identifies the member.

customer_idstring required

Identifies the enrolled customer.

program_idstring required

Identifies the loyalty program.

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

Current member status. Allowed values: ACTIVE, INACTIVE, DELETED. INACTIVE members cannot earn points or redeem rewards.

metadataobject required

Stores custom member metadata. Empty object when none is set.

created_atstring date-time required

Records when the member was created (ISO 8601).

updated_atstring date-time nullable required

Records the last update (ISO 8601). null if the member has never been updated.

object'member' required

Object type. Always member.

Changes

  • v24134cde57cdaRevision changes
    • breaking

      removed the required property ///////////// from the response with the status

    • breaking

      removed the required property ///////////// from the response with the status

    • breaking

      removed the required property ///////////// from the response with the status

    • breaking

      removed the required property ///////////// from the response with the status

    • info

      added the required property //////////////// to the response with the status

    • info

      added the required property //////////////// to the response with the status

    • info

      added the required property //////////////// to the response with the status

    • info

      added the required property //////////////// to the response with the status

  • v20d886da710c9Revision changes
    • breaking

      removed the required property //////////////// from the response with the status

    • breaking

      removed the required property //////////////// from the response with the status

    • breaking

      removed the required property //////////////// from the response with the status

    • breaking

      removed the required property //////////////// from the response with the status

    • info

      added the required property ///////////// to the response with the status

    • info

      added the required property ///////////// to the response with the status

    • info

      added the required property ///////////// to the response with the status

    • info

      added the required property ///////////// to the response with the status