API Reference
Users Management
Suspend/Restore User

User Management – Suspend/Restore User

Suspend or restore a user's account using an action flag.

Authentication

Authorization: Bearer <YOUR_AUTH_TOKEN>

Endpoint

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

Required Headers

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

Request Body

{ "action": "suspend", "userId": "<USER_ID>" }

or

{ "action": "restore", "userId": "<USER_ID>" }

Example Requests

JavaScript (fetch)

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

cURL

curl -X POST \
  'https://api.samvyo.com/api/user/suspendRestoreUser' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_AUTH_TOKEN>' \
  -d '{"action":"suspend","userId":"<USER_ID>"}'

Success Responses

Suspend

{
  "success": true,
  "user": {
    "id": "<USER_ID>",
    "accountSuspended": true
  }
}

Restore

{
  "success": true,
  "user": {
    "id": "<USER_ID>",
    "accountSuspended": false
  }
}

Failure Responses

Missing userId

{
  "success": false,
  "message": "userId is required to suspend/restore a user account."
}

Invalid action

{
  "success": false,
  "message": "Invalid action. Must be either 'suspend' or 'restore'."
}