live-chat

DELETE /v1/chat/widgets/{widgetId}

Delete a chat, with its conversations and canned replies.

All live-chat endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

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.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X DELETE https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
  -H "Authorization: Bearer zdk_live_…"

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. Removes the widget and everything stored under it (its conversations, their transcripts and the canned replies scoped to it); the embed key stops answering at once. On a WordPress site we host, the managed install is re-applied so the widget leaves the site's pages. Another organisation's chat is 404. Our own sites' chat cannot be deleted (422). Audit-logged as livechat.widget.deleted.

Parameters

NameTypeRequiredWhat it is
widgetId (path)stringYes—

Errors this endpoint can return

401 · 403 · 404 · 422