Skip to main content
POST
/
v1
/
users
/
seats
curl --request POST \ --url https://api.coderabbit.ai/v1/users/seats \ --header 'Content-Type: application/json' \ --header 'x-coderabbitai-api-key: <api-key>' \ --data ' { "action": "assign", "user_ids": [ "121358802", "22605247" ] } '
{
  "status": "success",
  "succeeded": [
    "121358802",
    "22605247"
  ],
  "failed": []
}
{
  "error": {
    "code": "BATCH_SIZE_EXCEEDED",
    "message": "Maximum 500 users per request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or inactive API key"
  }
}
{
  "error": {
    "code": "NOT_ADMIN",
    "message": "Only administrators can perform seat management operations"
  }
}
{
  "error": {
    "code": "LEGACY_API_KEY",
    "message": "You are using a legacy API key. We are deprecating use of legacy keys. Regenerate a new API key and retry the request."
  }
}
{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Max 10 requests per 60 seconds"
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error while listing users"
  }
}

Manage Seats

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 manage user seats

action
enum<string>
required

Action to perform

Available options:
assign,
unassign
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