OUoutcallerai
public

Update Echo configuration

Changed on

Update supported Echo widget settings for the workspace. Credentials are not accepted.

put/api/v1/public/echo/configuration

Request

  • Base URL
    https://api.outcallerai.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.outcallerai.com/api/v1/public/echo/configuration
  • Auth
    none declared. Required headers: Idempotency-Key

Headers

Idempotency-Keystring required

Request body

positionstring nullable
themestring nullable
agentNamestring nullable
welcomeMessagestring nullable
logoUrlstring nullable
primaryColorstring nullable
userBubbleColorstring nullable
userBubbleTextColorstring nullable
botBubbleColorstring nullable
botBubbleTextColorstring nullable
headerGradientFromstring nullable
headerGradientTostring nullable
launcherSizestring nullable
borderRadiusstring nullable
shadowSizestring nullable
inputPlaceholderstring nullable
suggestionsstring[] nullable
hideSuggestionsOnInteractboolean nullable
previewMessagesstring[] nullable
autoShowPreviewDelayinteger nullable
showBrandingboolean nullable
privacyPolicyUrlstring nullable
enableLeadCaptureboolean nullable
leadCaptureKeywordsstring[] nullable
leadCaptureMinutesThresholdinteger nullable
leadCaptureMessageThresholdinteger nullable
targetAgentIdForLeadsstring nullable
enableBrochureboolean nullable
brochureSuggestionTextstring nullable
allowedDomainsstring[] nullable
enableVoiceCallboolean nullable
selectedUseCaseIdstring nullable
mcpActionsEnabledboolean nullable
echoMcpPolicyJsonobject nullable

Response

Successful Response

idstring required
workspaceIdstring required
positionstring required
themestring required
agentNamestring required
welcomeMessagestring required
logoUrlstring nullable
primaryColorstring required
userBubbleColorstring required
userBubbleTextColorstring required
botBubbleColorstring required
botBubbleTextColorstring required
headerGradientFromstring required
headerGradientTostring required
launcherSizestring required
borderRadiusstring required
shadowSizestring required
inputPlaceholderstring required
suggestionsstring[]
hideSuggestionsOnInteractboolean
previewMessagesstring[]
autoShowPreviewDelayinteger
showBrandingboolean
privacyPolicyUrlstring required
enableLeadCaptureboolean
leadCaptureKeywordsstring[]
leadCaptureMinutesThresholdinteger
leadCaptureMessageThresholdinteger
targetAgentIdForLeadsstring nullable
enableBrochureboolean
brochureSuggestionTextstring required
allowedDomainsstring[]
enableVoiceCallboolean
selectedUseCaseIdstring nullable
mcpActionsEnabledboolean
echoMcpPolicyJsonobject nullable
createdAtstring date-time required
updatedAtstring date-time required

Changes

  • 29d015ec5474Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 2a1adc380310Revision changes
    • info

      endpoint added