User Privacy API

This is the API reference for metadata-matched deletion requests: authentication, request body, limits, and processing. To choose between user/account deletion, individual feedback removal, ingestion rules, or integration deletion, see Data Deletion Options in Enterpret. PII masking at ingestion is a separate workflow.

Introduction

The User Privacy API accepts deletion requests for data matched through configured metadata fields. Configure the identifiers and scope with your Enterpret team before submitting requests. This workflow can support your privacy process; it does not by itself establish compliance with a particular law.

Use Case

Use this workflow when you receive a deletion request from a user or need to remove data matched by configured identifiers. Confirm the matching fields, associated records, and any separately retained copies with your Enterpret team.

Authorization

Reach out to your customer success representative to obtain an API key for your data deletion requests.

NOTE: You must provide a list of metadata available in the Enterpret instance against which to match the User IDs submitted for deletion using a given API key.

This API Key should be used with every request as a value for the api-key header.

Submitting Deletion Requests

Use the API key obtained above to make a POST request to https://api.enterpret.com/webhook/delete/custom.

In the request body, include the list of User IDs (ids) for which you want to delete the data.

Sample Request Body:

{ "ids": [ "user_id_1", "user_id_2"] }

Request Limits

Submit no more than 100 IDs per request. To delete more than 100 IDs, split them across multiple requests. Contact Enterpret Support about request throughput and any applicable limits for your integration.

Processing of Deletion Requests

What is Deleted?

Depending on the configured metadata fields and matching scope, deletion requests can target the following data:

• Feedback Records: This includes any feedback and its associated metadata

• User Data: This includes all of the user's metadata along with any feedback that is associated with the user.

• Account Data: This includes account metadata and any associated user and feedback records.

Please note that the deletion is hierarchical:

• A record metadata match will delete the corresponding records.

• A user metadata match will delete the matching users as well as their related records.

• An account metadata key match will delete the account, and any associated users and related records.

Deletion SLA

Deletion requests are batched for scheduled processing. The default deletion-job schedule runs every 24 hours. Contact Enterpret Support to confirm your workspace's schedule, expected completion time, and deletion outcome.