Sign in
Webchat

Delete a webchat widget.

Deletes an existing webchat widget by its ID. Cascades to revoke the associated direct hash.

delete/webchat_widgets/{id}

Path parameters

idstring uuid required

The unique identifier of the widget. Returned from the POST /widgets response.

Response

Widget successfully deleted.

idstring uuid required

The unique identifier of the widget. Returned from the POST /widgets or GET /widgets response.

customer_idstring uuid required

The unique identifier of the associated customer. Returned from the GET /customers response.

namestring required

Name of the widget.

status'active' | 'inactive' required

The status of the widget.

welcome_messagestring required

The message shown to the visitor when the widget loads.

flow_idstring uuid required

The flow to trigger on the visitor's first inbound message. Returned from the POST /flows or GET /flows response.

session_idle_timeoutinteger required

Session idle timeout in seconds before the session is automatically ended.

tm_createstring date-time

Timestamp when the widget was created.

tm_updatestring date-time

Timestamp when the widget was last updated.

tm_deletestring date-time

Timestamp when the widget was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "name": "Support Widget",
  "status": "active",
  "welcome_message": "Hi! How can we help you today?",
  "flow_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "session_idle_timeout": 1800,
  "theme_config": {
    "primary_color": "#1a73e8",
    "logo_url": "https://cdn.example.com/logo.png",
    "position": "bottom_right"
  },
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Changes