Skip to main content
DELETE
JavaScript
Built for GDPR erasure requests. One call deletes every session belonging to a tenant across all widgets in the workspace, along with the conversations those sessions created. The response reports both counts.

tenantId is required, and that is the safety

An empty or missing tenantId is rejected rather than matching everything. There is no “delete all sessions in the workspace” spelling of this endpoint, so a bug in your parameter plumbing turns into a 400, not a workspace-wide purge. The tenant accepts the canonical tenant_… form or external_id:<value>, which is usually the natural one here: the erasure request arrives with your identifier for the customer, not Cadenya’s.

This deletes conversations. The single delete does not.

The single-session delete disassociates conversations and leaves them. This endpoint deletes them, because “erase this customer” means the content too. objectivesDeleted is your receipt for the erasure record. The tenant record itself survives, empty. To remove that too, finish with erase a tenant.

Erase a tenant

Remove the tenant record after its data.

List widget sessions

?tenantId= shows what this call takes with it.

Delete a widget session

One row, conversations kept.

List tenants

Resolve your customer identifier to a tenant.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Workspace ID.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

Query Parameters

tenantId
string

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

Delete tenant widget sessions response.

sessionsDeleted
integer<int32>
read-only

Number of sessions deleted.

objectivesDeleted
integer<int32>
read-only

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