v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Roles

Update a role

Edit a role. Can only be used with application keys belonging to administrators.

patch/api/v2/roles/{role_id}

Path parameters

role_idstring required

The unique identifier of the role.

Request body

Example request

{
  "data": {
    "id": "00000000-0000-1111-0000-000000000000",
    "relationships": {
      "permissions": {
        "data": [
          {
            "type": "permissions"
          }
        ]
      }
    },
    "type": "roles"
  }
}

Response

Example response

{
  "data": {
    "relationships": {
      "permissions": {
        "data": [
          {
            "type": "permissions"
          }
        ]
      }
    },
    "type": "roles"
  }
}