Programs

Deactivate program member

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 status.

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

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

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

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

    • deleted the path request parameter memberId

      request-parameter-removed

    • deleted the path request parameter programId

      request-parameter-removed

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

      response-body-all-of-added

    • removed the non-success response with the status

      response-non-success-status-removed

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

  • v2341403eb19e511613See the full diff
    • added the pattern ^lmbr_[a-f0-9]+$ to the path request parameter memberId

      request-parameter-pattern-added

    • added the pattern ^lprg_[a-f0-9]+$ to the path request parameter programId

      request-parameter-pattern-added

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • api operation id deactivateMember removed and replaced with deactivateProgramMember

      api-operation-id-removed

    • added the non-success response with the status

      response-non-success-status-added

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response's property pattern ^cust_[a-zA-Z0-9]+ was added for the status

      response-property-pattern-added

    • the response's property pattern ^lmbr_[a-f0-9]+$ was added for the status

      response-property-pattern-added

    • the response's property pattern ^lprg_[a-f0-9]+$ was added for the status

      response-property-pattern-added

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