Naar navigatie springen

Update Business Profile

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

Headers

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

Verzoek

This endpoint expects an object.
business_namestringOptioneelStandaard
Name of the business.
business_countrystring or nullOptioneel

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

business_descriptionstringOptioneelStandaard
What the business does, given to the receptionist.
timezonestringOptioneelformaat: "zoneinfo"
currencyenumOptioneelStandaard USD

Currency code for all prices (ISO 4217)

operating_hoursobjectOptioneel
tool_call_soundenum or nullOptioneel

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.

Toegestane waarden:

Response

Geslaagde response
idstring
created_at_unixinteger
updated_at_unixinteger
workspace_nowobject
Current time in workspace timezone, computed on each request.
business_namestringOptioneelStandaard
Name of the business.
business_countrystring or nullOptioneel

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

business_descriptionstringOptioneelStandaard
What the business does, given to the receptionist.
timezonestringOptioneelformaat: "zoneinfo"
currencyenumOptioneelStandaard USD

Currency code for all prices (ISO 4217)

operating_hoursobjectOptioneel
tool_call_soundenum or nullOptioneel

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.

Toegestane waarden:

Fouten

422
Unprocessable Entity Error