Update deployment settings.

patch

https://app.customgpt.ai/api/v1/projects/{projectId}/deployment/{section}

Updates a single deployment section for an agent. The section path parameter identifies which section to update (embed, live_chat, ai_assistant, instant_viewer, or sge). Only include the fields you want to change — omitted fields retain their current values. Settings restricted by your plan are silently ignored.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

projectId

integer

required

The unique agent identifier.

section

string

enum

required

Deployment section to update.

Allowed:

Body Params

Update one deployment section.

Notes:

Include only fields you want to change.
Fields that do not apply to the selected section path parameter are ignored.
Settings restricted by your plan are ignored.

width

number

≤ 10000

Widget width value.

Applies to: embed, live_chat.

widthUnit

string

enum

Unit for width.

Applies to: embed, live_chat.

Allowed:

height

number

≤ 10000

Widget height value.

Applies to: embed, live_chat, sge.

heightUnit

string

enum

Unit for height.

Applies to: embed, live_chat, sge.

Allowed:

heightType

string

enum

Whether height is fixed or automatic.

Applies to: embed, live_chat, sge.

Allowed:

resetConversation

boolean

Reset the conversation on each new session.

Applies to: embed, live_chat, ai_assistant, instant_viewer.

defaultButtonText

string

length ≤ 255

Label text on the default trigger button.

Applies to: ai_assistant, instant_viewer.

defaultButtonColor

string

length ≤ 9

^(#[A-Fa-f\d]{3}|#[A-Fa-f\d]{6}|#[A-Fa-f\d]{8})$

Hex color for the default trigger button. Accepted formats: #FFF, #FFFFFF, or #FFFFFFFF.

Applies to: ai_assistant, instant_viewer.

isUsingDefaultButton

boolean

Whether to show the default styled button.

Applies to: ai_assistant, instant_viewer.

isUsingCustomElement

boolean

Whether a custom HTML element is used as the trigger.

Applies to: ai_assistant, instant_viewer.

autoPopUp

integer

enum

Live chat auto-popup target. Accepted values: 0 (disabled), 1 (desktop), 2 (mobile), 3 (desktop and mobile).

Applies to: live_chat.

Allowed:

autoPromptStarterQuestion

boolean

Automatically prompt the first starter question.

Applies to: live_chat.

doNotPromptOnMobile

boolean

Suppress auto-prompts on mobile devices.

Applies to: live_chat.

autoStartConversation

boolean

Automatically start a new conversation when the widget opens.

Applies to: live_chat.

hidePromptFromStarterQuestionList

boolean

Hide the pre-prompt from the starter question list.

Applies to: live_chat.

position

string

enum

Screen position of the live chat bubble.

Applies to: live_chat.

Allowed:

chatbotType

string

enum

Visual style of the deployment widget. live_chat accepts window, compact, floating; ai_assistant and instant_viewer accept window, compact.

Applies to: live_chat, ai_assistant, instant_viewer.

Allowed:

isPrePromptEnabled

boolean

Whether the pre-prompt is enabled for this deployment.

Applies to: embed, live_chat, ai_assistant, instant_viewer.

isCRMIntegrationEnabled

boolean

Whether CRM integration is enabled for this deployment.

Applies to: embed, live_chat, ai_assistant, instant_viewer, sge.

continueConversation

boolean

Persist and continue the previous conversation.

Applies to: live_chat.

iconSize

string

enum

Icon size for the live chat bubble trigger.

Applies to: live_chat.

Allowed:

customSearchParameter

string

length ≤ 15

^[a-zA-Z0-9_\-]+$

URL query parameter name to pass as the search query. Alphanumeric, dash, underscore; max 15 characters.

Applies to: sge.

isCustomContextEnabled

boolean

Whether custom context injection is enabled.

Applies to: embed, live_chat, ai_assistant, instant_viewer, sge.

isLabelsFilterEnabled

boolean

Filter responses by source labels. Requires a plan with source labeling.

Applies to: embed, live_chat, ai_assistant, instant_viewer, sge.

labelsExclusive

boolean

When label filtering is active, use exclusive AND matching.

Applies to: embed, live_chat, ai_assistant, instant_viewer, sge.

mobileFontSize

boolean

Use mobile-optimized font sizing.

Applies to: embed, live_chat, ai_assistant, instant_viewer, sge.

delayIframeLoadMs

number

≥ 0

Milliseconds to delay iframe load.

Applies to: embed, sge.

Responses

200Deployment settings updated — returns the full settings object for all sections

400Bad Argument

401API Token is either missing or invalid

404Agent not found

422Bad Argument

500Internal Server Error