Suspend a subscriber

POST /api/v1/users/{id}/suspend prm_users_enable_disable

Sets enabled to false and, when the tenant has disconnect-on-update enabled, kicks any live session so the suspension takes effect now rather than at the next re-auth.

At a glance

Authentication: Staff token or session
Requires permission: prm_users_enable_disable Enable / suspend users
Rate limit: t_mutate

Parameters

Parameter	Description
`id`required path · integer	Subscriber id.

Errors

Code	When it is returned
`ERR_NOT_FOUND`404	no such subscriber, or one outside the caller's subtree

Request

curl -X POST "$BASE/api/v1/users/{id}/suspend" \
  -H "Authorization: Bearer $XR_TOKEN"

Response 200 OK

{
  "data": {
    "id": 4711,
    "username": "ahmed",
    "enabled": false,
    "status": { "enabled": false, "can_connect": false }
  }
}

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us