Skip to content
Vocapable Developers

Issue short-lived calendar choices for a carrier-confirmed handoff

POST
/v1/mobile/receptionist/handoffs/{handoff_id}/booking/availability
curl --request POST \
  --url https://api.vocapable.com/v1/mobile/receptionist/handoffs/example/booking/availability \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "start_date": "example", "end_date": "example", "duration_minutes": 1, "timezone": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
handoff_id
required
Handoff Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
MobileHandoffBookingAvailabilityRequest

A bounded, display-zone availability request for one eligible handoff.

There is no call, contact, attendee, connection, calendar, OAuth, or raw-time field in this model. The route derives those facts from the authenticated handoff and returns opaque slot snapshots rather than a reusable provider availability response.

object
start_date
required
Start Date
string
/^\d{4}-\d{2}-\d{2}$/
end_date
required
End Date
string
/^\d{4}-\d{2}-\d{2}$/
duration_minutes
required
Duration Minutes
integer
>= 5 <= 240
timezone
required
Timezone
string
>= 1 characters <= 64 characters
Examplegenerated
{
  "start_date": "example",
  "end_date": "example",
  "duration_minutes": 1,
  "timezone": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MobileHandoffBookingAvailability

Availability narrowed to one handoff; it has no provider connection metadata.

object
handoff_id
required
Handoff Id
string
timezone
required
Timezone
string
duration_minutes
required
Duration Minutes
integer
>= 5 <= 240
slots
Slots
Array<object>
MobileHandoffBookingSlot

One opaque, short-lived calendar slot the current member may choose.

object
id
required
Id
string
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
expires_at
required
Expires At
string format: date-time
Examplegenerated
{
  "handoff_id": "example",
  "timezone": "example",
  "duration_minutes": 1,
  "slots": [
    {
      "id": "example",
      "starts_at": "2026-04-15T12:00:00Z",
      "ends_at": "2026-04-15T12:00:00Z",
      "expires_at": "2026-04-15T12:00:00Z"
    }
  ]
}

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