Skip to content
vocapable.Docs

The owner's company-wide calling settings

PATCH
/v1/workspace/calling-settings
curl --request PATCH \
  --url https://api.vocapable.com/v1/workspace/calling-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_revision": 1, "allow_personal_phone": true, "allow_dial_pad": true, "show_customer_numbers": true, "allow_supervision": true, "summary_language": "spoken", "allow_offline_text_queue": true }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceCallingSettingsUpdate
object
expected_revision
required
Expected Revision
integer
>= 1
allow_personal_phone
Any of:
boolean
allow_dial_pad
Any of:
boolean
show_customer_numbers
Any of:
boolean
allow_supervision
Any of:
boolean
summary_language
Any of:
string
Allowed values: spoken en es
allow_offline_text_queue
Any of:
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceCallingSettings

The owner’s calling choices for the whole company. Every one defaults to off.

object
allow_personal_phone
required
Allow Personal Phone
boolean
allow_dial_pad
required
Allow Dial Pad
boolean
show_customer_numbers
required
Show Customer Numbers
boolean
revision
required
Revision
integer
updated_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
updated_at
required
Any of:
string format: date-time
allow_supervision
Allow Supervision
boolean
summary_language
Summary Language
string
default: spoken
Allowed values: spoken en es
allow_offline_text_queue
Allow Offline Text Queue
boolean
Example
{
  "allow_supervision": false,
  "summary_language": "spoken",
  "allow_offline_text_queue": false
}

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": {}
    }
  ]
}