Ir para a navegação

Update Business Profile

Update the business profile. Every receptionist is updated to match.

Cabeçalhos

xi-api-keystringOpcional
xi-workspace-idstring or nullOpcional
The customer workspace a reseller's API key acts on.

Solicitação

This endpoint expects an object.
business_namestringOpcionalPadrão é
Name of the business.
business_countrystring or nullOpcional

ISO 3166-1 alpha-2 country code where the business is based (e.g. ‘US’, ‘PL’, ‘DE’).

business_descriptionstringOpcionalPadrão é
What the business does, given to the receptionist.
timezonestringOpcionalformat: "zoneinfo"
currencyenumOpcionalPadrão é USD

Currency code for all prices (ISO 4217)

operating_hoursobjectOpcional
tool_call_soundenum or nullOpcional

Ambient sound played while any receptionist runs a tool (e.g. checking availability or looking up a client), filling the silence callers would otherwise hear. One sound for the whole workspace, because custom webhook and MCP tools are shared by every receptionist. Off when null.

Valores permitidos:

Resposta

Resposta bem-sucedida

idstring
created_at_unixinteger
updated_at_unixinteger
workspace_nowobject
Current time in workspace timezone, computed on each request.
business_namestringOpcionalPadrão é
Name of the business.
business_countrystring or nullOpcional

ISO 3166-1 alpha-2 country code where the business is based (e.g. ‘US’, ‘PL’, ‘DE’).

business_descriptionstringOpcionalPadrão é
What the business does, given to the receptionist.
timezonestringOpcionalformat: "zoneinfo"
currencyenumOpcionalPadrão é USD

Currency code for all prices (ISO 4217)

operating_hoursobjectOpcional
tool_call_soundenum or nullOpcional

Ambient sound played while any receptionist runs a tool (e.g. checking availability or looking up a client), filling the silence callers would otherwise hear. One sound for the whole workspace, because custom webhook and MCP tools are shared by every receptionist. Off when null.

Valores permitidos:

Erros

422
Unprocessable Entity Error