Update a custom role
curl --request PATCH \
--url https://api.coderabbit.ai/v1/configuration/roles/{roleId} \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"name": "<string>",
"permissions": [
{
"resource_id": "<string>"
}
],
"org_id": "<string>",
"org_name": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/configuration/roles/{roleId}"
payload = {
"name": "<string>",
"permissions": [{ "resource_id": "<string>" }],
"org_id": "<string>",
"org_name": "<string>",
"description": "<string>"
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
permissions: [{resource_id: '<string>'}],
org_id: '<string>',
org_name: '<string>',
description: '<string>'
})
};
fetch('https://api.coderabbit.ai/v1/configuration/roles/{roleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"role": {
"role": "<string>",
"role_name": "<string>",
"role_type": "system",
"description": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"permissions": [
{
"resource_id": "<string>",
"access_type": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}Update a custom role
Shared operations require a complete name and permission set, matching the native role editor. Existing REST partial updates remain unchanged.
PATCH
/
v1
/
configuration
/
roles
/
{roleId}
Update a custom role
curl --request PATCH \
--url https://api.coderabbit.ai/v1/configuration/roles/{roleId} \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"name": "<string>",
"permissions": [
{
"resource_id": "<string>"
}
],
"org_id": "<string>",
"org_name": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/configuration/roles/{roleId}"
payload = {
"name": "<string>",
"permissions": [{ "resource_id": "<string>" }],
"org_id": "<string>",
"org_name": "<string>",
"description": "<string>"
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
permissions: [{resource_id: '<string>'}],
org_id: '<string>',
org_name: '<string>',
description: '<string>'
})
};
fetch('https://api.coderabbit.ai/v1/configuration/roles/{roleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"role": {
"role": "<string>",
"role_name": "<string>",
"role_type": "system",
"description": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"permissions": [
{
"resource_id": "<string>",
"access_type": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}- CLI Tool
- MCP Server
coderabbit api request -X PATCH "/configuration/roles/$ROLE_ID" --input request.json
An agent connected to the CodeRabbit MCP server runs this operation as the
update_role tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "update_role",
"arguments": {
"roleId": "<roleId>",
"name": "<name>",
"permissions": []
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Body
application/json
Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.
Minimum string length:
1Was this page helpful?