---
title: "PATCH /api/v1/agents/{agentId}/deployment-settings"
method: PATCH
path: "/api/v1/agents/{agentId}/deployment-settings"
tags: ["agentDeploymentSettings"]
---

# PATCH /api/v1/agents/{agentId}/deployment-settings

`PATCH /api/v1/agents/{agentId}/deployment-settings`

## Request

- Base URL: `https://api.clerkchat.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.clerkchat.co/api/v1/agents/{agentId}/deployment-settings`
- Auth: none required

## Path parameters

- `agentId` string, required

## Request body

- object
  - `widgetEnabled` boolean, nullable
  - `widgetAllowedDomains` string[], nullable
  - `widgetShowStarterSuggestions` boolean, nullable
  - `widgetColor` string, nullable
  - `widgetAutoShowDelaySeconds` integer, nullable
  - `widgetAutoShowOnMobile` boolean, nullable
  - `widgetHorizontalOffset` integer, nullable
  - `widgetBottomOffset` integer, nullable
  - `widgetPoweredBy` boolean, nullable
  - `chatSoundsEnabled` boolean, nullable
  - `voiceEnabled` boolean, nullable
  - `helpPageEnabled` boolean, nullable
  - `helpPageTitle` string, nullable
  - `helpPageSubtitle` string, nullable
  - `helpPageInputPlaceholder` string, nullable
  - `theme` 'light' | 'dark' | 'system', nullable
  - `position` 'bottom-right' | 'bottom-left', nullable

## Response `200`

AgentDeploymentSettings

- AgentDeploymentSettingsEncoded
  - `agentId` string, required
  - `organizationId` string, required
  - `publicDeploymentId` string, required
  - `widgetEnabled` boolean, required
  - `widgetAllowedDomains` string[], required
  - `widgetShowStarterSuggestions` boolean, required
  - `widgetColor` string, required
  - `widgetAutoShowDelaySeconds` integer, required
  - `widgetAutoShowOnMobile` boolean, required
  - `widgetHorizontalOffset` integer, required
  - `widgetBottomOffset` integer, required
  - `widgetPoweredBy` boolean, required
  - `chatSoundsEnabled` boolean, required
  - `voiceEnabled` boolean, required
  - `helpPageEnabled` boolean, required
  - `helpPageTitle` string, required
  - `helpPageSubtitle` string, required
  - `helpPageInputPlaceholder` string, required
  - `theme` 'light' | 'dark' | 'system', required
  - `position` 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left', required
  - `updatedAt` union, required
    - number
    - 'Infinity' | '-Infinity' | 'NaN'

## Other responses

- `400`: BadRequest
- `401`: Unauthorized
- `403`: Forbidden
- `404`: NotFound
- `503`: PersistenceUnavailable

---

[API](https://skmtc.dev/clerkchat/apis/clerk-chat-api.md) · [All operations](https://skmtc.dev/clerkchat/apis/clerk-chat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/clerkchat/apis/clerk-chat-api/revisions/cc318e39e1d0?raw)