Seat Assignment Mode

Update the seat assignment mode for the organization. Only accessible by fully self-hosted organizations with enterprise plans.

POST /v1/users/seats/assignment

cURL

manual

curl --request POST \
  --url https://api.coderabbit.ai/v1/users/seats/assignment \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "mode": "manual"
}
'

200

{
  "mode": "manual"
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid enum value. Expected 'manual' | 'automatic', received 'invalid'"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or inactive API key"
  }
}

{
  "error": {
    "code": "NO_ACTIVE_SUBSCRIPTION",
    "message": "No active subscription found for the organization"
  }
}

{
  "error": {
    "code": "SELF_HOSTED_ONLY",
    "message": "This endpoint is only available for self-hosted instances"
  }
}

{
  "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 updating seat assignment mode"
  }
}

Update Seat Assignment Mode

To retrieve the current seat assignment mode, use the Users endpoint. The seat assignment mode is included in the response.

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

Only available for fully self-hosted organizations. See Seat assignment for details on assignment modes.

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 update the seat assignment mode

mode · enum<string> · required

The seat assignment mode to set. 'automatic' auto-assigns seats when CodeRabbit is tagged; 'manual' requires admin approval.

Available options: automatic, manual

Response

200

application/json

Seat assignment mode updated successfully

Seat assignment mode for the organization

mode · enum<string> · required

The current seat assignment mode. 'automatic' means new developers are auto-assigned seats when CodeRabbit is tagged; 'manual' requires admin approval.

Available options: automatic, manual