Skip to main content
POST
Change roles for multiple users
To install and sign in to the CLI, see Call from the CLI.
With org_id set to ALL, CodeRabbit changes each organization separately, so the change isn’t atomic: a user is listed in succeeded only when every organization succeeded. See Change a role on every organization of a self-hosted instance.

Authorizations

x-coderabbitai-api-key
string
header
required

See Authentication for the key types and where to create a key.

Body

application/json
role
string
required

Role ID to assign. Use cr_admin, cr_member, or a custom role UUID. cr_billing_admin cannot be assigned through this endpoint.

Example:

"6f1bb6c1-4766-4f09-9d0d-b998c33d2398"

user_ids
string[]
required

Array of user IDs to change roles for

Required array length: 1 - 500 elements

Provider user ID (Git provider's user identifier)

Minimum string length: 1
Example:
org_name
string

GitHub organization login for a workspace API key, matched case-insensitively. Supply either org_name or org_id, never both; omit for an organization-bound key.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$
org_id
string

For workspace-scoped API keys, supply this provider organization ID or org_name, never both. For self-hosted instance keys, use a provider organization ID or ALL (case-insensitive) to apply the role change across active organizations on that instance. Omit it to preserve single-organization behavior for self-hosted keys. Organization keys remain bound to their own organization; ALL is valid only for self-hosted instance keys.

Response

Role change completed (partial or full success)

status
enum<string>
required

Status of the operation - "success" if all succeeded, "partial_success" if some succeeded and some failed, "failure" if all failed

Available options:
success,
partial_success,
failure
Example:

"success"

succeeded
string[]
required

Array of user IDs that were successfully processed

Example:
failed
object[]
required

Array of failed users with error codes

Example: