Bulk update users

POST /v1/users/bulk

Apply an operation to several users at once. Each user is processed independently; failures are reported per user rather than failing the whole request.

Requires: user.edit

Request Body

User IDs and the operation to apply

BulkUpdateUsersRequest

operationrequired

"remove"

permissionsoptional

enum[]

roleIdoptional

string

userIdsrequired

string[]

Example Request

application/json

{
  "userIds": [
    "string"
  ],
  "operation": "remove",
  "roleId": "string",
  "permissions": [
    "organization.owner"
  ]
}

Response Schema

BulkUpdateUsersResponse

failedrequired

object[]

errorrequired

string

userIdrequired

string

succeededrequired

string[]

Example Response

201 OK — application/json

{
  "succeeded": [
    "string"
  ],
  "failed": [
    {
      "userId": "string",
      "error": "string"
    }
  ]
}