Bulk user operations

POST

/api/v1/organizations/{id}/bulk-users

curl --request POST \
  --url http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/bulk-users \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "userIds": [ "uuid1", "uuid2" ], "action": "enable_users", "reason": "example" }'

• Development
• Production

Perform bulk operations on users within an organization. Requires Super Admin privileges.

Authorizations

• api-key
• bearer

Parameters

Path Parameters

id

required

string format: uuid

Organization UUID

Request Body ^required

Media type application/json

object

userIds

required

User IDs to apply the action to

Array<string>

Example

[
  "uuid1",
  "uuid2"
]

action

required

Action to perform

string

Allowed values: enable_users disable_users remove_users

reason

Reason for the operation

string

Responses

200

Bulk operation completed

Media type application/json

object

processed

required

Total number of users processed

number

successful

required

Number of successful operations

number

failed

required

Number of failed operations

number

errors

Failed user IDs with error messages

object

key

additional properties

string

Example ^generated

{
  "processed": 1,
  "successful": 1,
  "failed": 1,
  "errors": {
    "additionalProperty": "example"
  }
}

400

Invalid input data

401

Unauthorized

403

Forbidden - Super Admin required

404

Organization not found