Skip to content
vocapable.Docs

Allow transfers to a number (owner)

POST
/v1/workspace/transfer-destinations
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/transfer-destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "phone_e164": "example", "payment_line": false }'

Only the owner decides where the company’s callers may be sent (E5-R3): a person picks an entry; the server dials the number stored here, from the business line.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceTransferDestinationCreate
object
name
required
Name
string
>= 1 characters <= 60 characters
phone_e164
required
Phone E164
string
/^\+[1-9]\d{6,14}$/
payment_line
Payment Line
boolean

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceTransferDestination

A number the owner allow-listed for external transfers and three-way calls (E5-R3).

object
id
required
Id
string
name
required
Name
string
phone_e164
required
Phone E164
string
revision
required
Revision
integer
payment_line
Payment Line
boolean
Example
{
  "payment_line": 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": {}
    }
  ]
}