Skip to main content
POST
/
v1
/
users
/
roles
curl --request POST \
  --url https://api.coderabbit.ai/v1/users/roles \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "role": "cr_admin",
  "user_ids": [
    "121358802",
    "22605247"
  ]
}
'
{
  "status": "success",
  "succeeded": [
    "121358802",
    "22605247"
  ],
  "failed": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Change User Roles

Requires Admin role. See Role-based access for details.

Authorizations

​
x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Headers

​
x-coderabbitai-api-key
string
required

Your CodeRabbit API key

Body

application/json

Request to change user roles

​
role
enum<string>
required

CodeRabbit user role to assign

Available options:
cr_admin,
cr_member
​
user_ids
string[]
required

Array of provider user IDs

Required array length: 1 - 500 elements

Response

Operation completed (check status field for partial failures)

Response for bulk operations with partial success model

​
status
enum<string>
required

Operation status: 'success' if all succeeded, 'partial_success' if some succeeded, 'failure' if all failed

Available options:
success,
partial_success,
failure
​
succeeded
string[]
required

Array of user IDs that were successfully processed

​
failed
object[]
required

Array of failures with error details