Programs

Update program member

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 a program member or Deactivate a 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 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

Changed in 3 of the 62 revisions of this API.822

  • v2dde32dd225f481See the full diff
    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • added to the response body allOf list for the response status

      response-body-all-of-added

    This revision also has 63 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • deleted the path request parameter memberId

      request-parameter-removed

    • deleted the path request parameter programId

      request-parameter-removed

    • endpoint added

      endpoint-added