> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Deactivate program member
>
Documentation in progress
This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.
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.
## OpenAPI
````yaml /openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members/{memberId}/deactivate
openapi: 3.1.0
info:
title: Voucherify Loyalty v2 API
version: 2.0.0
description: >-
Complete OpenAPI specification for the Voucherify Loyalty v2 API.
All endpoints require the LOYALTY_V2 feature flag.
Combined from per-domain specs: programs.yaml, members.yaml,
program-operations.yaml, card-definitions.yaml, earning-rules.yaml,
tier-structures.yaml, benefits.yaml, rewards.yaml, examine.yaml
servers:
- url: '{protocol}://{host}'
variables:
protocol:
default: https
enum:
- https
- http
host:
default: api.voucherify.io
security:
- X-App-Id: []
X-App-Token: []
- bearerAuth: []
tags:
- name: Programs
description: >-
Loyalty program CRUD, lifecycle management, program-scoped resource
assignments (card definitions, earning rules, rewards, tier structures),
member management (create, list, get, update, activate, deactivate,
delete), membership retrieval (member + program + cards with tier
progress, by customer ID, customer source ID, or member ID), card
operations (points adjustment, pending points, expiring points,
transactions), reward purchases, and activity history.
- name: Card definitions
description: >-
CRUD operations, lifecycle management, and activity history for card
definitions. Card definitions describe the configuration for loyalty
cards, including code generation, points expiration, earning/spending
limits, pending points, refunds, and balance settings.
- name: Earning rules
description: >-
Manage earning rules that define how customers earn points or receive
incentives based on triggers (events, segments, custom events). Includes
CRUD, lifecycle, and activity history.
- name: Tier structures
description: >-
CRUD operations, lifecycle management, and activity history for tier
structures. Includes nested tier definitions (create, list, update,
delete) within tier structures. Tier structures define the tiering model
for loyalty programs — how members qualify for and move between tiers.
- name: Benefits
description: >-
Manage benefit definitions (fixed points, proportional points, material,
digital). Includes CRUD, lifecycle transitions, and activity history.
- name: Rewards
description: >-
CRUD, lifecycle operations, and activity history for reward definitions.
Rewards can be material (product/SKU) or digital (discount coupons, gift
vouchers).
- name: Examine
description: >-
Evaluation endpoints that estimate earning opportunities and reward
availability for a customer across their loyalty program memberships,
without side effects.
paths:
/v2/loyalties/programs/{programId}/members/{memberId}/deactivate:
post:
tags:
- Programs
summary: Deactivate program member
description: >-
Documentation in progress
This documentation is in progress. The parameters, fields, request and
response bodies, and other data may be subject to change. If you need
more information or you want to share feedback, contact [Voucherify
support](https://www.voucherify.io/contact-support) or your Technical
Account Manager.
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.
operationId: deactivateProgramMember
parameters:
- name: programId
in: path
required: true
description: Unique loyalty program ID (format `lprg_[a-f0-9]+`).
schema:
type: string
pattern: ^lprg_[a-f0-9]+$
- name: memberId
in: path
required: true
description: Program member ID (format `lmbr_[a-f0-9]+`), assigned by Voucherify.
schema:
type: string
pattern: ^lmbr_[a-f0-9]+$
responses:
'200':
description: The deactivated member (without cards).
content:
application/json:
schema:
$ref: '#/components/schemas/Member'
'400':
description: >-
Validation error - request body or query parameters failed
validation, or the operation is not allowed in the current resource
state.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'409':
description: Conflict - e.g. duplicate resource or invalid state transition.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
Member:
type: object
description: A loyalty program member.
properties:
id:
type: string
pattern: ^lmbr_[a-f0-9]+$
description: Unique member ID.
customer_id:
type: string
pattern: ^cust_[a-zA-Z0-9]+
description: Unique Voucherify ID of the customer enrolled as this member.
program_id:
type: string
pattern: ^lprg_[a-f0-9]+$
description: Unique Voucherify ID of the loyalty program the member belongs to.
status:
type: string
enum:
- ACTIVE
- INACTIVE
- DELETED
description: >-
Current member status. `INACTIVE` member can't earn points or redeem
rewards.
metadata:
type: object
description: Free-form metadata attached to the member (empty object when none).
created_at:
type: string
format: date-time
description: Timestamp when the member was created (ISO 8601).
updated_at:
type:
- string
- 'null'
format: date-time
description: >-
Timestamp when the member was last updated (ISO 8601), or `null` if
never updated.
object:
type: string
const: member
description: Object type marker, always `member`.
required:
- id
- customer_id
- program_id
- status
- metadata
- created_at
- updated_at
- object
ErrorResponse:
type: object
description: Standard error response returned by all Loyalty v2 endpoints.
properties:
code:
type: integer
description: HTTP status code of the error.
key:
type: string
description: Machine-readable error key.
message:
type: string
description: Human-readable error message.
details:
type: string
description: Additional details about the error.
request_id:
type: string
description: Unique identifier of the request that produced the error.
resource_id:
type: string
description: Unique identifier of the resource that produced the error.
resource_type:
type: string
description: Type of the resource that produced the error.
securitySchemes:
X-App-Id:
type: apiKey
name: X-App-Id
in: header
X-App-Token:
type: apiKey
name: X-App-Token
in: header
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````