privacy
Open an operation to see its authentication, its parameters and the fields of its request and response.
4 operations
POST/v1/privacy/closure
Closes the organization: subscriptions end, sessions and tokens stop, its data is deleted within 30 days (owners).
/v1/privacy/closureAuthentication: Dashboard session
Request body
| Name | Type | Description |
|---|---|---|
confirmrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
closed_atrequired | string | |
purge_afterrequired | string |
POST/v1/privacy/erasures
Erases one end user by email or widget user id across tickets, subscriptions, identities, error events and reports (owners, admins).
/v1/privacy/erasuresAuthentication: Dashboard session
Request body
| Name | Type | Description |
|---|---|---|
email | string | |
user_id | string |
Response 200
| Name | Type | Description |
|---|---|---|
ticketsrequired | integer | |
messagesrequired | integer | |
filesrequired | integer | |
subscriptionsrequired | integer | |
identitiesrequired | integer | |
error_eventsrequired | integer | |
received_emailsrequired | integer |
POST/v1/privacy/exports
Exports the organization’s data: an archive is built and a download link is emailed to you (owners).
/v1/privacy/exportsAuthentication: Dashboard session
Response 202
| Name | Type | Description |
|---|---|---|
export_idrequired | string | |
requested_atrequired | string | |
emailrequired | string |
DELETE/v1/privacy/tickets/{id}
Deletes a ticket with its messages, files, subscribers, jobs and status page (owners, admins).
/v1/privacy/tickets/{id}Authentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
idpathrequired | string |
Response 200
| Name | Type | Description |
|---|---|---|
deletedrequired | true | |
ticket_idrequired | string | |
messagesrequired | integer | |
filesrequired | integer |