API Reference
Users Management
Revoke Users

User Management – Revoke Users

Revoke access for one or more users by ID.

Authentication

Authorization: Bearer <YOUR_AUTH_TOKEN>

Endpoint

POSThttps://api.samvyo.com/api/user/revokeOrgUsers

Required Headers

Content-Type: application/json
Authorization: Bearer <YOUR_AUTH_TOKEN>

Request Body

An array of objects with userId:

[
  { "userId": "<USER_ID_1>" },
  { "userId": "<USER_ID_2>" }
]

Example Requests

JavaScript (fetch)

const res = await fetch('https://api.samvyo.com/api/user/revokeOrgUsers', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${authToken}`
  },
  body: JSON.stringify([
    { userId: '<USER_ID_1>' },
    { userId: '<USER_ID_2>' }
  ])
});
const data = await res.json();

cURL

curl -X POST \
  'https://api.samvyo.com/api/user/revokeOrgUsers' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_AUTH_TOKEN>' \
  -d '[{"userId":"<USER_ID_1>"},{"userId":"<USER_ID_2>"}]'

Success Response

{
  "success": true
}

Failure Responses

Payload not an array

{
  "success": false,
  "message": "Invalid format. Payload must be an array of user details."
}

Empty array

{
  "success": false,
  "message": "User details array cannot be empty."
}