Skip to main content
PATCH
/
v2
/
organizations
/
{orgId}
/
roles
/
{roleId}
Update an organization role
curl --request PATCH \
  --url https://api.cal.com/v2/organizations/{orgId}/roles/{roleId} \
  --header 'Content-Type: application/json' \
  --data '{
  "color": "<string>",
  "description": "<string>",
  "permissions": [
    "eventType.read",
    "eventType.create",
    "booking.read"
  ],
  "name": "<string>"
}'
{
  "status": "success",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "color": "<string>",
    "description": "<string>",
    "organizationId": 123,
    "type": "SYSTEM",
    "permissions": [
      "booking.read",
      "eventType.create"
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Headers

​
Authorization
string

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

​
x-cal-secret-key
string

For platform customers - OAuth client secret key

​
x-cal-client-id
string

For platform customers - OAuth client ID

Path Parameters

​
orgId
number
required
​
roleId
string
required

Body

application/json
​
color
string

Color for the role (hex code)

​
description
string

Description of the role

​
permissions
enum<string>[]

Permissions for this role (format: resource.action). On update, this field replaces the entire permission set for the role (full replace). Use granular permission endpoints for one-by-one changes.

Example:
[
  "eventType.read",
  "eventType.create",
  "booking.read"
]
​
name
string

Name of the role

Minimum length: 1

Response

200 - application/json
​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
data
object
required