Skip to content
vocapable.Docs

The person a dialled number belongs to, or a new lightweight contact (owner-enabled)

POST
/v1/workspace/dial-pad/contacts
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/dial-pad/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "phone_e164": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceDialPadRequest
object
phone_e164
required
Phone E164
string
/^\+[1-9]\d{7,14}$/
Examplegenerated
{
  "phone_e164": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceDialPadContact

The person a dialled number belongs to: an existing one you can open, or a new lightweight contact you own (name it on the wrap-up).

object
contact_id
required
Contact Id
string
organization_id
required
Any of:
string
created
required
Created
boolean
display_name
required
Display Name
string
timezone_known
required
Timezone Known
boolean
Examplegenerated
{
  "contact_id": "example",
  "organization_id": "example",
  "created": true,
  "display_name": "example",
  "timezone_known": true
}

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