v3

latestSwagger 2.02026-08-067506752.0 MB

role

Update an existing role

patch/v1/org/{orgId}/role/{roleId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

roleIdstring required

Role id

Request body

labelstring

human-readable full name of role

descriptionstring

description of role

policyIdsstring[]

the policies that define the role

Example request

{
  "label": "Engineering People Manager",
  "description": "This role is able to create and update new job data for the engineering department.",
  "policyIds": [
    "588f7ee98f138b19220041a7"
  ]
}

Response

role updated