v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB
WidgetSessionService
Widget Sessions

Delete all of a tenant's widget sessions

Deletes every session belonging to a tenant across all widgets in the workspace, along with the conversations those sessions created — built for GDPR erasure requests. The tenant is required; an empty value is rejected rather than matching everything.

delete/v1/workspaces/{workspaceId}/widget_sessions

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

Query parameters

tenantIdstring

Tenant whose sessions to delete. Required — an empty value is rejected rather than matching everything. Accepts the canonical tenant_… form or the external_id:<value> form.

Response

OK

sessionsDeletedinteger

Number of sessions deleted.

objectivesDeletedinteger

Number of conversations (objectives) deleted along with the sessions.