Sign in

v1

latestOpenAPI 3.0.32026-07-12132428.7 KB
Roles

putRole

Create or update role

put/v1/permissions/roles/{roleId}

Path parameters

roleIdstring required

Format: <organization_id>:<slug>

Example:123:owner

Request body

OR
OR
OR
OR

Example request

{
  "grants": [
    {
      "action": "entity-read",
      "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",
      "conditions": [
        {
          "attribute": "workflows.primary.task_name",
          "values": [
            "Qualification"
          ]
        }
      ],
      "dependencies": [
        {
          "action": "entity-read",
          "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",
          "conditions": [
            {
              "attribute": "workflows.primary.task_name",
              "values": [
                "Qualification"
              ]
            }
          ]
        }
      ]
    }
  ],
  "id": "123:owner",
  "name": "Owner",
  "slug": "owner",
  "expires_at": "2028-07-21T17:32:28Z",
  "organization_id": "123",
  "parent_role": "123:owner"
}

Response

ok

OR
OR
OR
OR

Example response

{
  "id": "123:owner",
  "name": "Owner",
  "slug": "owner",
  "expires_at": "2028-07-21T17:32:28Z",
  "organization_id": "123",
  "grants": [
    {
      "action": "entity-read",
      "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",
      "conditions": [
        {
          "attribute": "workflows.primary.task_name",
          "values": [
            "Qualification"
          ]
        }
      ]
    }
  ],
  "parent_role": "123:owner"
}