POpoll-the-people
Deployment Settings

Update deployment settings.

Changed on

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.

patch/api/v1/projects/{projectId}/deployment/{section}

Request

Path parameters

projectIdinteger required
Example:1

The unique agent identifier.

section'embed' | 'live_chat' | 'ai_assistant' | 'instant_viewer' | 'sge' required
Example:embed

Deployment section to update.

Request body

widthnumber

Widget width value.

Applies to: embed, live_chat.

widthUnit'px' | '%'

Unit for width.

Applies to: embed, live_chat.

heightnumber

Widget height value.

Applies to: embed, live_chat, sge.

heightUnit'px' | '%'

Unit for height.

Applies to: embed, live_chat, sge.

heightType'fixed' | 'auto'

Whether height is fixed or automatic.

Applies to: embed, live_chat, sge.

resetConversationboolean

Reset the conversation on each new session.

Applies to: embed, live_chat, ai_assistant, instant_viewer.

defaultButtonTextstring

Label text on the default trigger button.

Applies to: ai_assistant, instant_viewer.

defaultButtonColorstring

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

Applies to: ai_assistant, instant_viewer.

isUsingDefaultButtonboolean

Whether to show the default styled button.

Applies to: ai_assistant, instant_viewer.

isUsingCustomElementboolean

Whether a custom HTML element is used as the trigger.

Applies to: ai_assistant, instant_viewer.

autoPopUp0 | 1 | 2 | 3

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

Applies to: live_chat.

autoPromptStarterQuestionboolean

Automatically prompt the first starter question.

Applies to: live_chat.

doNotPromptOnMobileboolean

Suppress auto-prompts on mobile devices.

Applies to: live_chat.

autoStartConversationboolean

Automatically start a new conversation when the widget opens.

Applies to: live_chat.

hidePromptFromStarterQuestionListboolean

Hide the pre-prompt from the starter question list.

Applies to: live_chat.

position'right' | 'left'

Screen position of the live chat bubble.

Applies to: live_chat.

chatbotType'window' | 'compact' | 'floating'

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.

isPrePromptEnabledboolean

Whether the pre-prompt is enabled for this deployment.

Applies to: embed, live_chat, ai_assistant, instant_viewer.

isCRMIntegrationEnabledboolean

Whether CRM integration is enabled for this deployment.

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

continueConversationboolean

Persist and continue the previous conversation.

Applies to: live_chat.

iconSize'small' | 'medium' | 'large'

Icon size for the live chat bubble trigger.

Applies to: live_chat.

customSearchParameterstring

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

Applies to: sge.

isCustomContextEnabledboolean

Whether custom context injection is enabled.

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

isLabelsFilterEnabledboolean

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

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

labelsExclusiveboolean

When label filtering is active, use exclusive AND matching.

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

mobileFontSizeboolean

Use mobile-optimized font sizing.

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

delayIframeLoadMsnumber

Milliseconds to delay iframe load.

Applies to: embed, sge.

Example request

{
  "width": 100,
  "widthUnit": "%",
  "height": 500,
  "heightUnit": "px",
  "heightType": "fixed",
  "defaultButtonText": "Ask AI",
  "defaultButtonColor": "#7367f0",
  "isUsingDefaultButton": true,
  "autoStartConversation": true,
  "position": "right",
  "chatbotType": "compact",
  "iconSize": "small",
  "customSearchParameter": "q",
  "mobileFontSize": true
}

Response

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

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "embed": {
      "width": 100,
      "widthUnit": "%",
      "height": 500,
      "heightUnit": "px",
      "heightType": "fixed",
      "mobileFontSize": true
    },
    "live_chat": {
      "width": 100,
      "widthUnit": "%",
      "height": 500,
      "heightUnit": "px",
      "heightType": "fixed",
      "mobileFontSize": true,
      "position": "right",
      "chatbotType": "compact",
      "iconSize": "small",
      "autoStartConversation": true
    },
    "ai_assistant": {
      "mobileFontSize": true,
      "defaultButtonText": "Ask AI",
      "defaultButtonColor": "#7367f0",
      "isUsingDefaultButton": true,
      "chatbotType": "compact"
    },
    "instant_viewer": {
      "mobileFontSize": true,
      "defaultButtonText": "Ask AI",
      "defaultButtonColor": "#7367f0",
      "isUsingDefaultButton": true,
      "chatbotType": "window"
    },
    "sge": {
      "mobileFontSize": true,
      "height": 500,
      "heightUnit": "px",
      "heightType": "fixed",
      "customSearchParameter": "q"
    }
  }
}

Changes