Sign in
Orgs / Roles

Update an organization role

patch/v2/organizations/{orgId}/roles/{roleId}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

orgIdnumber required
roleIdstring required

Headers

Authorizationstring

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

x-cal-secret-keystring

For platform customers - OAuth client secret key

x-cal-client-idstring

For platform customers - OAuth client ID

Request body

colorstring

Color for the role (hex code)

descriptionstring

Description of the role

permissionsstring[]

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.

namestring

Name of the role

Example request

{
  "permissions": [
    "eventType.read",
    "eventType.create",
    "booking.read"
  ]
}

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": {
    "permissions": [
      "booking.read",
      "eventType.create"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.