Delete User Data API
Use this API to delete personally identifiable information (PII) from specified conversations and messages. This operation removes user data but will not delete expressions (messages annotated to intents). To delete expressions, use the "Untrain expression" feature directly in the AI Agents dashboard. Note that removing expressions may affect your bot’s performance.
All requests should be made to your API base URL: https://api.ultimate.ai
JSON format
The request body is represented as JSON objects with the following property:
| Name | Type | Required | Description |
|---|---|---|---|
| conversationIds | array | Yes | List of conversation ids that will be processed for deletion. Each value should be a string |
Delete User Data
POST /gdpr/delete-user-data
Deletes personally identifiable information (PII) within the selected conversations and messages.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
| authorization | string | header | Yes | Your API authorization token |
| organizationid | string | header | No | The id of the organization |
| botid | string | header | Yes | The id of the bot for which data will be deleted |
Example body
{"conversationIds": ["123456789", "987654321"]}