Suspend many subscribers

POST /api/v1/users/bulk-disable prm_users_enable_disable

Takes an array of ids and suspends each. One request against the per-tenant write budget instead of one per subscriber, which is the difference between fitting in a minute and not.

A bulk call reports per-id outcomes and returns 200 even when some ids failed. failed is always present, as an array, and each entry carries a stable reason (not_found, not_authorized, error) alongside a localized message. Branch on reason; treating the 200 as "all of them worked" is the mistake this shape exists to prevent.

At a glance

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

Parameters

Parameter	Description
`ids`required body · array	Subscriber ids.

Request

curl -X POST "$BASE/api/v1/users/bulk-disable" \
  -H "Authorization: Bearer $XR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [4711, 4712, 4713]
}'

Response 200 OK

{
  "data": {
    "updated": [4711, 4713],
    "failed": [
      { "id": 4712, "reason": "not_authorized", "message": "You may not act on this record." }
    ]
  }
}

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