Programs

Update program member

Changed on

Updates a program member's metadata. Provided object keys are merged into the existing metadata; omitted keys are preserved. Pass metadata: null to clear all metadata (sets it to an empty object).

This endpoint cannot change status. Use Activate program member or Deactivate program member for status transitions.

Records a vl.member.updated activity. Returns the updated member without the cards array. Returns 404 when the program or member does not exist. Returns 400 when the request body fails validation or the project vl_member metadata schema rejects the payload.

put/v2/loyalties/programs/{programId}/members/{memberId}

Request

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

Request body

metadataobject nullable required

Member metadata to apply. Object keys are merged into existing metadata (omitted keys are preserved). Validated against the vl_member metadata schema when configured. Pass null to clear all metadata.

Response

The updated member (without 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

  • v26a418ac8b7b1Revision changes
    • breaking

      added to the request body allOf list

    • warning

      removed the request property

  • v2f95b50556c93Revision changes
    • breaking

      added the new required request property

    • warning

      removed from the request body allOf list