Workspace settings

Update account

Update account details, settings, and custom attributes

patch/v1/workspaces/{workspace_id}

Request

  • Base URL: https://api.oxvo.com
  • URL: https://api.oxvo.com/v1/workspaces/{workspace_id}
  • Auth: API key in header api_access_token

Path parameters

workspace_idinteger required

The numeric ID of the workspace

Request body

namestring

Name of the account

localestring

The locale of the account

domainstring

The domain of the account

support_emailstring

The support email of the account

auto_resolve_afterinteger nullable

Auto resolve conversations after specified minutes

auto_resolve_messagestring nullable

Message to send when auto resolving

auto_resolve_ignore_waitingboolean nullable

Whether to ignore waiting conversations for auto resolve

industrystring

Industry type

company_sizestring

Company size

timezonestring

Account timezone

Example request

{
  "name": "My Account",
  "locale": "en",
  "domain": "example.com",
  "support_email": "support@example.com",
  "auto_resolve_after": 1440,
  "auto_resolve_message": "This conversation has been automatically resolved due to inactivity",
  "industry": "Technology",
  "company_size": "50-100",
  "timezone": "UTC"
}

Response

Success

idnumber

Account ID

namestring

Name of the account

localestring

The locale of the account

domainstring

The domain of the account

support_emailstring

The support email of the account

statusstring

The status of the account

created_atstring date-time

The creation date of the account

cache_keysobject

Cache keys for the account

featuresobject

Enabled features for the account

Changes

No recorded changes to this operation across all 1 revision of this API.