Skip to content
vocapable.Docs

Change a custom role

PATCH
/v1/workspace/roles/{role_id}
curl --request PATCH \
  --url https://api.vocapable.com/v1/workspace/roles/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_revision": 1, "name": "example", "description": "example", "capabilities": [ "example" ], "permissions": [ "example" ], "scope": "company" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
role_id
required
Role Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceCustomRoleUpdate
object
expected_revision
required
Expected Revision
integer
>= 1
name
Any of:
string
>= 1 characters <= 60 characters
description
Any of:
string
<= 500 characters
capabilities
Any of:
Array<string>
<= 32 items
permissions
Any of:
Array<string>
<= 64 items
scope
Any of:
string
Allowed values: company teams

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceCustomRole
object
id
required
Id
string
name
required
Name
string
description
required
Any of:
string
capabilities
required
Capabilities
Array<string>
Allowed values: view_all_customers reassign manage_team edit_routing manage_integrations manage_workflows approve bulk_import export merge pricing_override refunds recording_access billing view_team_metrics publish_knowledge manage_merchant manage_access view_audit_log
scope
required
Scope
string
Allowed values: company teams
holder_count
required
Holder Count
integer
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
permissions
Permissions
Array<string>
Example
{
  "capabilities": [
    "view_all_customers"
  ],
  "scope": "company"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}