API Docs / Operations / Roles / Update Role

Update Role

PUT /tenants/{tenant}/roles/{code}

Replaces a custom role's name, description and permission set. Requested permissions are capped at the capabilities the requesting user holds on each entity.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

code* path string

Request Body*

{
  "name": "string",
  "description": "string",
  "permissions": {
    "Tasks": [
      "..."
    ],
    "Users": [
      "..."
    ],
    "Clients": [
      "..."
    ],
    "Contacts": [
      "..."
    ],
    "ClientContacts": [
      "..."
    ]
  }
}

Responses

200 OK
400 Bad Request
401 Unauthorized – Invalid or missing API key
404 Not Found