Skip to main content
POST
Batch Update Users

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

dryRun
boolean
default:false

Resolve the identifiers and report what would change, without writing.

Body

application/json

Apply one set of changes to many users.

identifiers accepts a user id, email or slug for each user, so the caller does not have to resolve them first; anything that matches nothing is reported back rather than failing the batch.

identifiers
string[]
required
Required array length: 1 - 1000 elements
updates
BatchUserUpdates · object
required

The fields a batch edit may change. At least one must be given.

Mirrors the admin UI's batch panel: ban/unban, grant/revoke beta, and add/remove blacklist modules. Blacklist changes are add/remove rather than a replacement list, because a batch spans users with different blacklists and a replacement would flatten them all to the same value.

Response

Successful Response

data
BatchUpdateUsersResult · object | null

Response data

status
string | null

Response status