agentDeploymentSettings

get/api/v1/public/help-pages/{agentId}

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/help-pages/{agentId}
  • Auth: none required

Path parameters

agentIdstring required

Response

PublicHelpPage

organizationIdstring required
agentIdstring required
displayNamestring required
faviconUrlstring nullable required
welcomeMessagestring nullable required
titlestring required
subtitlestring required
inputPlaceholderstring required
poweredByboolean required
chatSoundsEnabledboolean required
voiceEnabledboolean required
theme'light' | 'dark' | 'system' required

Changes

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