Update an organization team role

PATCH /v2/organizations/{orgId}/teams/{teamId}/roles/{roleId}

Update an organization team role

cURL

curl --request PATCH \
  --url https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/roles/{roleId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "color": "<string>",
  "description": "<string>",
  "permissions": [
    "eventType.read",
    "eventType.create",
    "booking.read"
  ],
  "name": "<string>"
}
'

200

{
  "status": "success",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "type": "SYSTEM",
    "permissions": [
      "booking.read",
      "eventType.create"
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "color": "<string>",
    "description": "<string>",
    "teamId": 123
  }
}

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

teamId · 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.

Available options: role.create, role.read, role.update, role.delete, eventType.create, eventType.read, eventType.update, eventType.delete, team.read, team.update, team.delete, team.invite, team.remove, team.listMembers, team.listMembersPrivate, team.changeMemberRole, team.impersonate, booking.read, booking.readTeamBookings, booking.readRecordings, booking.update, insights.read, workflow.create, workflow.read, workflow.update, workflow.delete, routingForm.create, routingForm.read, routingForm.update, routingForm.delete, webhook.create, webhook.read, webhook.update, webhook.delete

Example:

[
  "eventType.read",
  "eventType.create",
  "booking.read"
]

name · string

Name of the role

Minimum string length: 1

Response

200 - application/json

status · enum<string> · required

Available options: success, error

Example:

"success"

data · object · required

Show child attributes