Skip to content
Vocapable Developers

Version-check and update bounded receptionist business facts

PATCH
/v1/mobile/receptionist/numbers/{number_id}/studio
curl --request PATCH \
  --url https://api.vocapable.com/v1/mobile/receptionist/numbers/example/studio \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_version": 1, "business_facts": { "additionalProperty": "example" }, "short_greeting": "example", "escalation_preference": "standard", "temporary_status": { "template": "service_update", "message": "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
MobileReceptionistStudioPatch

A complete, version-checked mobile Studio state replacement.

Requiring all editable state in the request makes an explicit removal distinguishable from a dropped field on a weak network. The native app starts from a live read and sends this exact object through the fresh browser-proof binding.

object
expected_version
required
Expected Version
integer
>= 1
business_facts
Business Facts
object
<= 4 properties
key
additional properties
string
short_greeting
Any of:
string
<= 180 characters
escalation_preference
Escalation Preference
string
default: standard
Allowed values: standard handoff_when_available booking_first
temporary_status
Any of:
MobileTemporaryCustomerStatus

One bounded, expiring proposed public-status update.

The finite template is shown in the native preview and recorded in the audit trail. The message remains concise, cannot alter policy/tool wording, and must be reviewed in canonical intelligence before it can be spoken. Its expiry travels with the source evidence so reviewers do not mistake a temporary notice for durable business knowledge.

object
template
required
Template
string
Allowed values: service_update special_hours weather_delay
message
required
Message
string
>= 1 characters <= 180 characters
expires_at
required
Expires At
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MobileReceptionistStudioSummary

One safe receptionist fact-draft projection for native operations views.

object
phone_number_id
required
Phone Number Id
string
has_published_receptionist
required
Has Published Receptionist
boolean
business_facts
Business Facts
object
key
additional properties
string
short_greeting
Any of:
string
escalation_preference
Escalation Preference
string
default: standard
Allowed values: standard handoff_when_available booking_first
temporary_status
Any of:
MobileTemporaryCustomerStatus

One bounded, expiring proposed public-status update.

The finite template is shown in the native preview and recorded in the audit trail. The message remains concise, cannot alter policy/tool wording, and must be reviewed in canonical intelligence before it can be spoken. Its expiry travels with the source evidence so reviewers do not mistake a temporary notice for durable business knowledge.

object
template
required
Template
string
Allowed values: service_update special_hours weather_delay
message
required
Message
string
>= 1 characters <= 180 characters
expires_at
required
Expires At
string format: date-time
version
required
Version
integer
>= 1
updated_at
Any of:
string format: date-time
Example
{
  "escalation_preference": "standard",
  "temporary_status": {
    "template": "service_update"
  }
}

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