Skip to content
Vocapable Developers

Set a mandatory-expiry emergency route override

PUT
/v1/mobile/receptionist/numbers/{number_id}/emergency-override
curl --request PUT \
  --url https://api.vocapable.com/v1/mobile/receptionist/numbers/example/emergency-override \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "mode": "ai", "rep_id": "example", "expires_at": "2026-04-15T12:00:00Z" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
number_id
required
Number Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
EmergencyOverrideRequest

A time-bounded emergency route above one number’s ordinary policy.

forward accepts a tenant-owned human-rep id only. The router resolves it again at write time and the carrier ingress resolves it again at execution time, so a client can never turn this into an arbitrary-number dialer or leave a stale forwarding destination active after a rep is disabled.

object
mode
required
Mode
string
Allowed values: ai voicemail forward
rep_id
Any of:
string
>= 1 characters <= 128 characters
expires_at
required
Expires At
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
EmergencyOverride

The durable current override for one inbound number.

object
id
required
Id
string
phone_number_id
required
Phone Number Id
string
mode
required
Mode
string
Allowed values: ai voicemail forward
rep_id
Any of:
string
status
required
Status
string
Allowed values: active cleared expired invalid
version
required
Version
integer
>= 1
expires_at
required
Expires At
string format: date-time
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
cleared_at
Any of:
string format: date-time
invalidated_at
Any of:
string format: date-time
Example
{
  "mode": "ai",
  "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": {}
    }
  ]
}