Skip to main content
PATCH
/
organisations
/
{orgId}
/
users
/
{userId}
# Deactivate a user (e.g. account suspension)
curl -X PATCH https://api.voxmind.ai/organisations/42/users/1001 \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"is_active": false}'

{
  "id": 1001,
  "org_id": 42,
  "external_id": "user_98765",
  "is_active": false,
  "created_at": "2025-02-10T09:15:00Z",
  "updated_at": "2025-03-15T12:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.voxmind.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Currently supports updating the is_active flag on a user record. Setting is_active: false deactivates a user — they will no longer be able to authenticate via Voxmind until reactivated. The voiceprint data is preserved, so reactivation is instant with no re-enrollment required. This is the preferred approach when a user leaves your platform, has their account suspended, or should temporarily lose voice authentication access. Use deletion only when you need to permanently remove voiceprint data (e.g. GDPR erasure requests).

​
Path Parameters

​
orgId
string
required
Your organisation’s unique identifier.
​
userId
string
required
Voxmind’s internal numeric ID for the user.

​
Request Body

​
is_active
boolean
default:"true"
Set to false to deactivate the user. Set back to true to reactivate.
# Deactivate a user (e.g. account suspension)
curl -X PATCH https://api.voxmind.ai/organisations/42/users/1001 \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"is_active": false}'

{
  "id": 1001,
  "org_id": 42,
  "external_id": "user_98765",
  "is_active": false,
  "created_at": "2025-02-10T09:15:00Z",
  "updated_at": "2025-03-15T12:00:00Z"
}