agentDeploymentSettings

get/api/v1/public/widgets/{publicDeploymentId}/config

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/public/widgets/{publicDeploymentId}/config
  • Auth: none required

Path parameters

publicDeploymentIdstring required

Response

PublicWidgetConfiguration

namestring required
welcomeMessagestring required
startersstring[] required
avatarUrlstring nullable required
showStarterSuggestionsboolean required
colorstring required
theme'light' | 'dark' | 'system' required
position'bottom-right' | 'bottom-left' required
autoShowDelaySecondsinteger required
autoShowOnMobileboolean required
horizontalOffsetinteger required
bottomOffsetinteger required
poweredByboolean required
chatSoundsEnabledboolean required
voiceEnabledboolean required

Changes

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