Set up or change the chat widget. A person's setting

Before you call

Credential

Authorization: Bearer $KEY

Scope

contacts:admin

Sdk

contacts.chat.save

Cli

contacts chat save

Request bodyapplication/json, required

• inboxIdstring (uuid)
• titlestring
  Default: Chat with us. At most 80 characters.
• agentNamestring
  Default: Assistant. At most 60 characters.
• greetingstring
  Default: Hi. How can we help?. At most 300 characters.
• accentstring
  Default: #1f4fd8. Pattern: ^#[0-9a-fA-F]{6}$.
• positionstring
  One of: right, left. Default: right.
• emailstring
  One of: ask, required, never. Default: ask.
• disclosurestring
  Default: You are chatting with an AI assistant. A person can join at any time.. At most 300 characters.
• hoursobject or null
  Default: null.
• awayMessagestring
  Default: We are away right now. Leave a message and we will answer when we are back.. At most 300 characters.
• handoffobject
  Default: {}.
  • enabledboolean
    Default: true.
  • labelstring
    Default: Talk to a person. At most 40 characters.
• csatobject
  Default: {}.
  • enabledboolean
    Default: true.
• transcriptobject
  Default: {}.
  • offerboolean
    Default: true.
• noticestring
  Default: Your messages are saved so that we can answer you.. At most 300 characters.
• privacyUrlstring (uri)
  At most 300 characters.
• allowedOriginslist of string
• defaultLanguagestring
  Default: en. Pattern: ^[a-z]{2}(-[A-Za-z]{2})?$.

Responses

• 200application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring