Passer à la navigation

Update Business Profile

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

En-têtes

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

Requête

This endpoint expects an object.
business_namestringOptionnelPar défaut
Name of the business.
business_countrystring or nullOptionnel

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

business_descriptionstringOptionnelPar défaut
What the business does, given to the receptionist.
timezonestringOptionnelformat: "zoneinfo"
currencyenumOptionnelPar défaut USD

Currency code for all prices (ISO 4217)

operating_hoursobjectOptionnel
tool_call_soundenum or nullOptionnel

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.

Valeurs autorisées:

Réponse

Réponse réussie

idstring
created_at_unixinteger
updated_at_unixinteger
workspace_nowobject
Current time in workspace timezone, computed on each request.
business_namestringOptionnelPar défaut
Name of the business.
business_countrystring or nullOptionnel

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

business_descriptionstringOptionnelPar défaut
What the business does, given to the receptionist.
timezonestringOptionnelformat: "zoneinfo"
currencyenumOptionnelPar défaut USD

Currency code for all prices (ISO 4217)

operating_hoursobjectOptionnel
tool_call_soundenum or nullOptionnel

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.

Valeurs autorisées:

Erreurs

422
Unprocessable Entity Error