---
title: "Update workspace settings"
method: PATCH
path: "/workspace/{workspaceId}/settings"
tags: ["Workspace"]
---

# Update workspace settings

`PATCH /workspace/{workspaceId}/settings`

## Request

- Base URL: `https://api.savanto.ai`
- URL: `https://api.savanto.ai/workspace/{workspaceId}/settings`
- Auth: HTTP bearer

Update workspace settings such as live agent configuration, description, and special instructions.

## Path parameters

- `workspaceId` string, required

## Request body

- object
  - `liveAgent` object
    - `enabled` boolean
    - `provider` 'none' | 'slack' | 'whatsapp' | 'teams'
    - `autoHandoff` boolean
    - `manualHandoff` boolean
    - `escalationPrompt` string
    - `inactivityTimeout` integer
    - `contactFormEnabled` boolean
    - `businessHours` string
  - `workspaceDescription` string
  - `specialInstructions` string
  - `triageProgressMessage` string
  - `composerProgressMessage` string
  - `builtinTools` object
    - `product` object, nullable
      - `tools` object[], nullable
        - `name` string, required
        - `baseUrl` string, uri, required
        - `responseFormat` 'json' | 'xml', required
        - `auth` object
          - `type` 'bearer' | 'header' | 'basic' | 'query', required
          - `headerName` string
          - `queryParamName` string
          - `value` string, required
        - `requiresAuth` boolean
        - `endpoints` object[], required
          - `toolName` string, required
          - `description` string, required
          - `method` 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH', required
          - `path` string, required
          - `parameters` object[], required
            - `name` string, required
            - `in` 'query' | 'path' | 'body', required
            - `required` boolean, required
            - `description` string, required
            - `type` 'string' | 'number' | 'boolean', required
            - `defaultValue` string
          - `requestTimeoutMs` integer
          - `dropPaths` string[]
      - `toolProgressMessages` object, nullable
      - `maxTurns` integer, nullable
      - `usageHints` string, nullable
    - `post` object, nullable
      - `tools` object[], nullable
        - `name` string, required
        - `baseUrl` string, uri, required
        - `responseFormat` 'json' | 'xml', required
        - `auth` object
          - `type` 'bearer' | 'header' | 'basic' | 'query', required
          - `headerName` string
          - `queryParamName` string
          - `value` string, required
        - `requiresAuth` boolean
        - `endpoints` object[], required
          - `toolName` string, required
          - `description` string, required
          - `method` 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH', required
          - `path` string, required
          - `parameters` object[], required
            - `name` string, required
            - `in` 'query' | 'path' | 'body', required
            - `required` boolean, required
            - `description` string, required
            - `type` 'string' | 'number' | 'boolean', required
            - `defaultValue` string
          - `requestTimeoutMs` integer
          - `dropPaths` string[]
      - `toolProgressMessages` object, nullable
      - `maxTurns` integer, nullable
      - `usageHints` string, nullable

## Response `200`

Updated settings

- object
  - `object` 'workspace', required
  - `requestId` string, required
  - `data` object, required
    - `settings` object, required

## Other responses

- `400`: Validation error
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `409`: Conflict
- `413`: Payload too large
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/savanto/apis/savanto-api.md) · [All operations](https://skmtc.dev/savanto/apis/savanto-api/llms.txt) · [OpenAPI document](https://skmtc.dev/savanto/apis/savanto-api/revisions/82437327a878?raw)