Skip to main content
PATCH
/
settings
/
general
Update general settings.
curl --request PATCH \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/settings/general \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "opening_hours": [
    [
      [
        "06:00",
        "12:00"
      ],
      [
        "13:00",
        "20:00"
      ]
    ]
  ],
  "force_close": false,
  "send_welcome_message": true,
  "welcome_message_open": "<string>",
  "welcome_message_closed": "<string>",
  "custom_tenant_name": "<string>",
  "custom_notifications_email": "<string>",
  "logo_url": "<string>",
  "primary_color": "ff00ff",
  "send_privacy_message": true,
  "privacy_link": "<string>",
  "privacy_message": "<string>",
  "notify_on_message": true,
  "notify_after_minutes": 123,
  "rating_invite_message": "<string>",
  "rating_external_link": "<string>",
  "mark_external_messages_as_read": true,
  "delete_messages_after_days": 90
}'
{
  "data": {
    "opening_hours": [
      [
        [
          "06:00",
          "12:00"
        ],
        [
          "13:00",
          "20:00"
        ]
      ]
    ],
    "force_close": false,
    "send_welcome_message": true,
    "welcome_message_open": "<string>",
    "welcome_message_closed": "<string>",
    "custom_tenant_name": "<string>",
    "custom_notifications_email": "<string>",
    "logo_url": "<string>",
    "primary_color": "ff00ff",
    "send_privacy_message": true,
    "privacy_link": "<string>",
    "privacy_message": "<string>",
    "notify_on_message": true,
    "notify_after_minutes": 123,
    "rating_invite_message": "<string>",
    "rating_external_link": "<string>",
    "mark_external_messages_as_read": true,
    "delete_messages_after_days": 90
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

General configuration settings.

​
opening_hours
string[][][]

Array of opening hours in Europe/Berlin. 7 entries for each weekday. Starting at monday. Each day is an array of periods with start and end time.

Required array length: 7 elements
​
force_close
boolean
default:false

Set true to ignore evaluating opening hours and always appear closed.

​
send_welcome_message
boolean
​
welcome_message_open
string

Text to send when open.

​
welcome_message_closed
string

Text to send when closed.

​
custom_tenant_name
string | null

If set, overrides the name used while creating the tenant. Will be displayed for rating.

​
custom_notifications_email
string | null

If set, overrides the address used for sending notification emails. Default is address used when creating the tenant.

​
logo_url
string | null

Link to external logo image. File will be downloaded and field will be replaced with internal URL. Logo available via internal URL "<client-url>/logo". Set null to remove. Image must have mime type of jpeg or png. Dimensions must match (quadratic) and be at least 1024x1024. White background preferred.

​
primary_color
string | null

Optional hex color for theme. Will be used for rating.

Example:

"ff00ff"

​
send_privacy_message
boolean
​
privacy_link
string | null

Optional link to custom privacy policy. If value is set to null, a default privacy page URL will be generated from the tenants info.

​
privacy_message
string

Text to send to inform about privacy. Should contain $link$ placeholder!

​
notify_on_message
boolean

Send email notification when a new message arrives and is not read within given amount of minutes.

​
notify_after_minutes
integer

Number of minutes before the notification will be sent.

​
rating_invite_message
string

Message template used to generate rating invite. Should contain $link$ placeholder!

​
rating_external_link
string | null

Link to Google reviews if user gave 4 or 5 stars.

​
mark_external_messages_as_read
boolean
default:true

If enabled and the mark read endpoint is called, the external service will also be instructed to mark their message as read. (E.g. for WhatsApp, the customer will get the blue check marks.)

​
delete_messages_after_days
integer
default:90

Number of days after a message will be deleted. The conversation must be in done state!

Response

200 - application/json

Success

​
data
object

General configuration settings.