Made in 10Docs
GuidesAPI
ReferenceWebsite widget

Set a deployment's widget appearance

Replaces the whole appearance (`null` or `{}` goes back to the widget's defaults).

PUT
/keys/{key_id}/appearance

Authorization

secretKey
headerAuthorizationBearer <sk_live_… or sk_test_… (a prefix and 40 base62 characters)>

A secret key from the dashboard, sent as Authorization: Bearer sk_live_…. Live keys run real, charged calls; test keys (sk_test_…) run calls of at most 60 seconds, 20 a day per organization, never charged. Each key sees only its own env's calls, meetings, webhooks, memories and analytics. Publishable keys (pk_…) are refused.

Path Parameters

key_id*string

A deployment's publishable key's id (key_…, not the key itself).

Match^key_[0-9A-Za-z]{20}$
Example"key_9Zc4Pw7NbT2xKm5RqL8v"

Request Body

application/json
  1. body
appearance*|

The whole appearance; it replaces what was there. null or {} goes back to the defaults.

Response Body

The appearance as stored.

application/json
  1. response
key_id*KeyId

A key's id (never the key itself).

Match^key_[0-9A-Za-z]{20}$
Example"key_9Zc4Pw7NbT2xKm5RqL8v"
appearance*

How a deployment's widget looks and behaves. Every part is optional: anything left out takes the widget's own default. The tag's data-* attributes win over it on a page. At most 48 KB of JSON; unknown fields are refused.

Example
{  "theme": "auto",  "colors": {    "accent": "#1e6fd9"  },  "launcher": {    "style": "face_label",    "label": {      "en": "Talk to us"    }  },  "teaser": {    "messages": {      "en": [        "Hi",        "I'm here if you need anything"      ]    },    "delay_seconds": 8,    "frequency": "once_per_session",    "pages": {      "hide_on": [        "/checkout*"      ]    }  },  "panel": {    "title": {      "en": "Alex at Nordlicht"    }  }}
Example Request
curl -X PUT 'https://api.daxov.com/v1/keys/key_9Zc4Pw7NbT2xKm5RqL8v/appearance' \  -H 'Content-Type: application/json' \  -d '{  "appearance": {    "theme": "auto",    "colors": {      "accent": "#1e6fd9"    },    "launcher": {      "style": "face_label",      "label": {        "en": "Talk to us"      }    },    "teaser": {      "messages": {        "en": [          "Hi",          "I'\''m here if you need anything"        ]      },      "delay_seconds": 8,      "frequency": "once_per_session",      "pages": {        "hide_on": [          "/checkout*"        ]      }    },    "panel": {      "title": {        "en": "Alex at Nordlicht"      }    }  }}'
Example Response
{  "key_id": "key_9Zc4Pw7NbT2xKm5RqL8v",  "appearance": {    "theme": "auto",    "colors": {      "accent": "#1e6fd9"    },    "launcher": {      "style": "face_label",      "label": {        "en": "Talk to us"      }    },    "teaser": {      "messages": {        "en": [          "Hi",          "I'm here if you need anything"        ]      },      "delay_seconds": 8,      "frequency": "once_per_session",      "pages": {        "hide_on": [          "/checkout*"        ]      }    },    "panel": {      "title": {        "en": "Alex at Nordlicht"      }    }  }}