Settings

Tags: business-hours, configuration, settings, workspace

Workspace configuration and settings management

In the product: Workspace Settings

Resources

Request and response models used by the endpoints on this page.

BusinessHoursStatusResponse

Field	Type	Required	Description
isBusinessHours	Boolean	✓

Example:

{
  "isBusinessHours": false  // Boolean
}

UpdateWorkspaceDefaultsRequest

Field	Type	Required	Description
defaultAgentId	Integer
defaultPhoneNumberId	Integer
emailFooter	String
enableAudioRecording	Boolean
enableVoicemailDetection	Boolean
escalationBusinessHours	String
escalationNotifiedMessageTemplate	String
escalationOfflineMessageTemplate	String
escalationOnlineMessageTemplate	String
escalationPausedMessageTemplate	String
pauseOnEscalate	Boolean
shortenUrls	Boolean
transcriptionModel	String

Example:

{
  "defaultPhoneNumberId": 0  // Integer, optional,
  "defaultAgentId": 0  // Integer, optional,
  "escalationBusinessHours": "string"  // String, optional,
  "escalationOnlineMessageTemplate": "string"  // String, optional,
  "escalationOfflineMessageTemplate": "string"  // String, optional,
  "escalationNotifiedMessageTemplate": "string"  // String, optional,
  "escalationPausedMessageTemplate": "string"  // String, optional,
  "emailFooter": "string"  // String, optional,
  "pauseOnEscalate": false  // Boolean, optional,
  "enableAudioRecording": false  // Boolean, optional,
  "enableVoicemailDetection": false  // Boolean, optional,
  "shortenUrls": false  // Boolean, optional,
  "transcriptionModel": "string"  // String, optional
}

UpdateWorkspaceFeaturesRequest

Field	Type	Required	Description
features	dict[str, bool]	✓

Example:

{
  "features": {}  // dict[str, bool]
}

WorkspaceFeatureState

Field	Type	Required	Description
category	String	✓
description	String	✓
editable	Boolean	✓
enabled	Boolean	✓
icon	String
name	String	✓
slug	String	✓

Example:

{
  "slug": "string"  // String,
  "name": "string"  // String,
  "description": "string"  // String,
  "category": "string"  // String,
  "icon": "string"  // String, optional,
  "enabled": false  // Boolean,
  "editable": false  // Boolean
}

WorkspaceFeaturesResponse

Field	Type	Required	Description
features	Array	✓

Example:

{
  "features": []  // Array<WorkspaceFeatureState>
}

WorkspaceSettingsResponse

Field	Type	Required	Description
defaultAgentId	Integer	✓
defaultChatModel	String	✓
defaultInferenceModel	String	✓
defaultPhoneNumberId	Integer	✓
defaultRealtimeModel	String	✓
defaultVoiceModel	String	✓
emailFooter	String	✓
enableAudioRecording	Boolean	✓
enableVoicemailDetection	Boolean	✓
escalationBusinessHours	String	✓
escalationNotifiedMessageTemplate	String	✓
escalationOfflineMessageTemplate	String	✓
escalationOnlineMessageTemplate	String	✓
escalationPausedMessageTemplate	String	✓
firstRunMode	String
id	Integer	✓
pauseOnEscalate	Boolean	✓
sesDomain	String	✓
shortenUrls	Boolean	✓
shortenUrlsAvailable	Boolean	✓
shortenUrlsExampleUrl	String	✓
slug	String	✓
transcriptionModel	String
workspaceFolderId	Integer

Example:

{
  "id": 0  // Integer,
  "slug": "string"  // String,
  "defaultPhoneNumberId": 0  // Integer,
  "defaultAgentId": 0  // Integer,
  "workspaceFolderId": 0  // Integer, optional,
  "escalationBusinessHours": "string"  // String,
  "escalationOnlineMessageTemplate": "string"  // String,
  "escalationOfflineMessageTemplate": "string"  // String,
  "escalationNotifiedMessageTemplate": "string"  // String,
  "escalationPausedMessageTemplate": "string"  // String,
  "emailFooter": "string"  // String,
  "pauseOnEscalate": false  // Boolean,
  "sesDomain": "string"  // String,
  "enableAudioRecording": false  // Boolean,
  "enableVoicemailDetection": false  // Boolean,
  "shortenUrls": false  // Boolean,
  "shortenUrlsExampleUrl": "string"  // String,
  "shortenUrlsAvailable": false  // Boolean,
  "transcriptionModel": "string"  // String, optional,
  "defaultChatModel": "string"  // String,
  "defaultRealtimeModel": "string"  // String,
  "defaultInferenceModel": "string"  // String,
  "defaultVoiceModel": "string"  // String,
  "firstRunMode": "string"  // String, optional
}

Endpoints

• GET /api/v2/w/{workspace_uuid}/business-hours-status - Business Hours Status
• GET /api/v2/w/{workspace_uuid}/defaults - Defaults
• PUT /api/v2/w/{workspace_uuid}/defaults - Update Defaults
• GET /api/v2/w/{workspace_uuid}/features - Features
• PUT /api/v2/w/{workspace_uuid}/features - Update Features
• GET /api/v2/w/{workspace_uuid}/first-run-state - First Run State
• PUT /api/v2/w/{workspace_uuid}/first-run-state - Update First Run State

Business Hours Status

GET /api/v2/w/{workspace_uuid}/business-hours-status

Description:

Get current business hours status

Get the current business hours status for the workspace.

Authorization: Requires workspace:read scope

Response: See BusinessHoursStatusResponse

---

Defaults

GET /api/v2/w/{workspace_uuid}/defaults

Description:

Get workspace default settings

Get the default settings for a workspace.

If no settings row exists yet, returns workspace defaults. The row is created on the first update.

Authorization: Requires workspace:read scope

Response: See WorkspaceSettingsResponse

---

Update Defaults

PUT /api/v2/w/{workspace_uuid}/defaults

Description:

Update workspace default settings

Update default settings for a workspace.

Authorization: Requires workspace:write scope

Parameters:

• request - See UpdateWorkspaceDefaultsRequest

Response: See WorkspaceSettingsResponse

---

Features

GET /api/v2/w/{workspace_uuid}/features

Description:

Features this workspace's plan allows, and whether each one is on.

Each entry carries editable: false means an administrator has locked the feature and a change to it will be refused.

Gated on WORKSPACE_WRITE rather than a read scope on purpose: this is the settings surface, and everything it lists is something the caller is about to be offered a toggle for. A member who cannot change any of it has no use for the list.

Authorization: Requires workspace:write scope

Response: See WorkspaceFeaturesResponse

---

Update Features

PUT /api/v2/w/{workspace_uuid}/features

Description:

Turn plan-allowed features on or off for this workspace.

A feature the org plan does not include is a 400. A feature an administrator has locked is a 403; the response says which and why.

Authorization: Requires workspace:write scope

Parameters:

• request - See UpdateWorkspaceFeaturesRequest

Response: See WorkspaceFeaturesResponse

---

First Run State

GET /api/v2/w/{workspace_uuid}/first-run-state

Authorization: Requires workspace:read scope

Response: See FirstRunState

---

Update First Run State

PUT /api/v2/w/{workspace_uuid}/first-run-state

Authorization: Requires workspace:write scope

Parameters:

• request (FirstRunState)

Response: See FirstRunState

---