Skip to content
vocapable.Docs

Name a line, limit its caller ID, or make it the default

PATCH
/v1/workspace/phone-lines/{line_id}
curl --request PATCH \
  --url https://api.vocapable.com/v1/workspace/phone-lines/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_revision": 1, "name": "example", "caller_id_access": "everyone", "is_company_default": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
line_id
required
Line Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspacePhoneLineUpdate
object
expected_revision
required
Expected Revision
integer
>= 1
name
Any of:
string
>= 1 characters <= 60 characters
caller_id_access
Any of:
string
Allowed values: everyone members
is_company_default
Any of:
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspacePhoneLine
object
id
required
Id
string
name
required
Name
string
phone_e164
required
Phone E164
string
is_company_default
required
Is Company Default
boolean
caller_id_access
required
Caller Id Access
string
Allowed values: everyone members
members
required
Members
Array<object>
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
usable_by_you
required
Usable By You
boolean
sms_capable
required
Sms Capable
boolean
revision
required
Revision
integer
kind
required
Kind
string
Allowed values: number verified_caller_id
outbound_only
required
Outbound Only
boolean
Example
{
  "caller_id_access": "everyone",
  "kind": "number"
}

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