agentDeploymentSettings

get/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

agentIdstring required

Response

AgentDeploymentSettings

agentIdstring required
organizationIdstring required
publicDeploymentIdstring required
widgetEnabledboolean required
widgetAllowedDomainsstring[] required
widgetShowStarterSuggestionsboolean required
widgetColorstring required
widgetAutoShowDelaySecondsinteger required
widgetAutoShowOnMobileboolean required
widgetHorizontalOffsetinteger required
widgetBottomOffsetinteger required
widgetPoweredByboolean required
chatSoundsEnabledboolean required
voiceEnabledboolean required
helpPageEnabledboolean required
helpPageTitlestring required
helpPageSubtitlestring required
helpPageInputPlaceholderstring required
theme'light' | 'dark' | 'system' required
position'bottom-right' | 'bottom-left' | 'top-right' | 'top-left' required

Changes

No recorded changes to this operation across all 1 revision of this API.