Programs

Deactivate program member

Changed on

Moves an ACTIVE member to INACTIVE and sets updated_at. Records a vl.member.deactivated activity. An INACTIVE member can't earn or spend points. No request body.

Returns the member without a cards array.

Returns 404 when the program doesn't exist, or when the member doesn't exist in that program. The program is checked first. A DELETED member returns 404. Returns 400 with key invalid_state_transition when the member is already INACTIVE.

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

Request

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

Response

The deactivated member, without cards. Status is always INACTIVE.

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

  • v2338a5e34004eRevision changes
    • info

      the endpoint scheme security X-App-Id AND X-App-Token was added to the API

    • info

      the endpoint scheme security bearerAuth was added to the API

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

    • 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

    • warning

      deleted the path request parameter memberId

    • warning

      deleted the path request parameter programId

    • info

      added to the response body allOf list for the response status

    • info

      removed the non-success response with the status