Skip to content
Vocapable Developers

Create a tenant-owned human handoff destination

POST
/v1/human-reps
curl --request POST \
  --url https://api.vocapable.com/v1/human-reps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "destination_e164": "example", "user_id": "example", "transfer_enabled": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
HumanRepCreateRequest

Create a tenant-owned human handoff destination.

object
display_name
required
Display Name
string
>= 1 characters <= 200 characters
destination_e164
required
Destination E164
string
/^\+[1-9]\d{7,14}$/
user_id
Any of:
string
>= 1 characters
transfer_enabled
Transfer Enabled
boolean
default: true

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
HumanRep
object
id
required
Id
string
display_name
required
Display Name
string
destination_e164
required
Destination E164
string
user_id
Any of:
string
status
required
Status
string
Allowed values: active inactive
transfer_enabled
required
Transfer Enabled
boolean
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
  "status": "active"
}

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