Skip to main content
PATCH
Update a custom role

Update Custom Role

Updates custom role metadata, permissions, or default status. System roles are immutable. When updating is_default: omitting it preserves the current default status, true sets this role as default (clearing any previous default), and false unsets this role as default.
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.

Path Parameters

roleId
string
required

Body

application/json
org_id
string

Required when authenticating with a workspace-scoped API token: the git-provider organization id to target within the token's workspace. Ignored for organization and self-hosted keys.

name
string
description
string | null
is_default
boolean
permissions
object[]

Response

200

Custom role updated