Skip to content
Vocapable Developers

Update a human handoff destination

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
rep_id
required
Rep Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
HumanRepUpdateRequest

Change a destination deliberately; an inactive rep is never selected.

object
display_name
Any of:
string
>= 1 characters <= 200 characters
destination_e164
Any of:
string
/^\+[1-9]\d{7,14}$/
user_id
Any of:
string
>= 1 characters
status
Any of:
string
Allowed values: active inactive
transfer_enabled
Any of:
boolean

Responses

Section titled “Responses”

200

Section titled “200”

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