Sign in
Programs

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

Moves the member to INACTIVE status and records a vl.member.deactivated activity. No request body. Returns 404 when the program or member does not exist. Returns 400 (invalid_state_transition) when the member cannot be deactivated from its current state.

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

Path parameters

programIdstring required

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

memberIdstring required

Program member ID (format lmbr_[a-f0-9]+).

Response

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

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

objectstring required

Object type marker, always member.

Changes

No recorded changes to this endpoint across all 1 revision of this API.