Branding & Settings

Update an agent's branding & settings (partial — only provided fields change).

patch/api/v1/agents/{agent}/settings

Request

  • Base URL: https://www.cysora.com
  • URL: https://www.cysora.com/api/v1/agents/{agent}/settings
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

labelstring

New display label. Empty string clears it.

descriptionstring

New description. Empty string clears it.

promptPlaceholderstring

New chat-input placeholder. Empty string clears it.

quickLinksstring[] nullable

Replacement list of quick-start prompts; null clears the list.

theme'light' | 'grey' | 'dark'

Widget color theme.

primaryColorstring

Primary accent color (CSS color value). Empty string clears it.

sendWeeklyEmailsboolean

Enable or disable the weekly performance email.

hasWebsiteboolean

Toggle WhatsApp-first mode. false de-emphasizes website surfaces across the dashboard; true restores them. Set from the Business info page.

aiAssistantsboolean

Turn the AI assistants channel on or off. false hides the agent's public guide, closes its assistant conversation API, and drops the guide link from newly copied snippets.

Response

Success.

Changes

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