COcoderabbit
Role Management

Update a custom role

Changed on

Updates custom role metadata, permissions, or default status. System roles are immutable. Omitting is_default preserves the current default status; true clears any previous default; false unsets this role as default.

patch/v1/roles/{roleId}

Request

  • Base URL
    https://api.coderabbit.ai
  • Auth
    API key in header x-coderabbitai-api-key

Path parameters

roleIdstring required

Request body

org_idstring

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.

namestring
descriptionstring nullable
is_defaultboolean

Response

Custom role updated

Changes