update frontdesk settings

Connect your Vapi assistant and switch answering on or off. With answer_source: vapi the key and the assistant are checked at Vapi first and nothing is stored unless Vapi accepts both. answer_source: waapi switches answering off and deletes the stored Vapi key and assistant id. Answering with Frontdesk's own answers is switched on in the account only (409 use_dashboard). vapi.api_key is write-only. Answers with the settings as stored and node_updated. Needs the update ability.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Instance ID

Body Params

Any of the fields; at least one. Omitted fields keep their stored value.

boolean

Switch answering on or off. true needs answer_source: vapi (in this request or stored); otherwise 409 use_dashboard. Other refusals are 409 with a reason code.

string
enum

vapi checks key and assistant at Vapi before saving. waapi switches answering off and deletes the stored Vapi key and assistant id.

Allowed:
vapi
object | null

Only with answer_source: vapi (in this request or stored); otherwise 422. null, like omitting a field, keeps the stored values.

Responses

401

Unauthorized — invalid or missing bearer token

403

Forbidden — the token lacks the update ability, or the account is blocked

404

Not found — the instance does not exist or does not belong to you

use_dashboard: the result would be answering switched on with answer_source: waapi (Frontdesk's own answers are set up in the account). globally_disabled: any change while Frontdesk is not available. node_too_old: enabled: true on an instance whose server version cannot forward messages yet.

vapi.api_key: missing, not a valid key, or "Vapi did not accept this API key." On vapi.assistant_id: not a UUID, or "No assistant with this id for this key." On vapi: Vapi fields without answer_source: vapi (vapi: null is allowed and keeps the stored values). Nothing was saved.

rate_limited: more than 10 answer-source saves for this instance in a minute. Retry after the Retry-After header (seconds).

vapi_unreachable: Vapi did not answer the check (timeout or a server error). Nothing was saved; try again.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json