Authentication
Send an API key as a bearer token. The key must carry the livechat.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Requires livechat.manage. The new widget is created switched off: a chat window that starts talking to a customer's visitors before they have asked for one is a consent problem, not a feature.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | No | — |
site_id | string | No | — |
name | string | Yes | — |
team_name | string | No | — |
allowed_origins | string[] | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
site_id | string | Yes | — |
name | string | Yes | — |
public_key | string | Yes | — |
enabled | boolean | Yes | Whether the chat renders. Created FALSE always: the plugin ships in the deploy footprint of every WordPress site we host, so a widget may exist for a customer who never asked for… |
allowed_origins | string[] | Yes | Origins the widget may be embedded on. An EMPTY list refuses every page rather than allowing any — this is the only control stopping somebody else's site opening conversations… |
tier | string | Yes | The tier this widget is on. Since 2026-09-29 hosting includes no Premium, so this is the tier that was bought (the same value as purchased_tier). |
tier_source | string<free, purchase> | Yes | Why the widget is on that tier: purchase means the Premium extra was bought for this site, free means it was not. (hosting was retired on 2026-09-29 with the hosting… |
purchased_tier | string | Yes | The tier actually PAID for. |
greeting | string | Yes | — |
team_name | string | Yes | — |
accent_colour | string | Yes | — |
position | string<left, right> | Yes | — |
hide_branding | boolean | Yes | — |
logo_url | string | Yes | The uploaded logo, or empty. Shown here whatever the tier so the customer sees what is stored; visitors are served it only on Premium. |
ai_enabled | boolean | Yes | — |
offline_email | string | Yes | — |
business_hours | object | No | — |
open_now | boolean | Yes | Whether the chat currently reads as open. Opening hours are a Premium setting, so a free chat is always open whatever hours it has stored. |
ai_allowance | ChatAiAllowance | Yes | — |
limits | object | Yes | — |
premium_extra_code | string | Yes | The catalogue code to buy for the premium tier. |
Errors this endpoint can return
401 · 403 · 422