purge end user data

View as Markdown
# Purge End User Data Permanently deletes all privacy-related data for a specific end user identified by their server key and account ID. This endpoint enables granular data deletion for individual end users while maintaining data for other users. ## Endpoint ``` DELETE {base_url}/api/v1/{account_id}/privacy/end-users/{server_key}/{end_user_account_id} ``` ## Required Variables - **base_url**: The base URL for the BotBye API - **account_id**: Your unique account identifier - **server_key**: The server key associated with the end user - **end_user_account_id**: The unique identifier for the specific end user to be deleted ## Authentication Requires API key authentication via the `api_key` variable. ## Response Returns a confirmation response indicating successful deletion of the specified end user's data. ## ⚠️ Warning **This action is irreversible.** Once end user data is purged, it cannot be recovered. This operation: - Permanently removes all data for the specified end user - Does not affect other end users' data - Cannot be undone or reversed ## Use Cases - **Individual Deletion Requests**: Fulfill specific end user's right to erasure - **Selective Data Removal**: Delete data for specific users without affecting others - **Privacy Compliance**: Respond to individual GDPR/CCPA deletion requests - **Data Minimization**: Remove unnecessary end user data - **User Opt-Out**: Honor end user requests to stop data collection and remove existing data ## Best Practices 1. Retrieve end user data using the GET endpoint before deletion 2. Verify the server_key and end_user_account_id are correct 3. Document the deletion request with timestamps and request details 4. Maintain compliance records of the deletion 5. Confirm the deletion was successful by checking the response ## Data Scope This endpoint removes all end user-specific data including: - End user profile information - Behavioral and tracking data - Session history - Associated metadata - Activity timestamps ## Notes The granular nature of this endpoint allows you to maintain data isolation and delete specific end user data without impacting your broader customer account or other end users.

Authentication

X-Api-Keystring

Project API token. Generate it in your BotBye account and send it in the X-Api-Key request header.

Path parameters

account_idstringRequired
server_keystringRequired
end_user_account_idstringRequired

Response headers

Content-Lengthinteger
Connectionstring

Response

purge end user data