v1

latestOpenAPI 3.1.02026-07-226130.1 KB

Purge Visitors

The Purge Visitors API helps teams comply with end-user bulk data deletion requests mandated by laws like GDPR and CCPA. This endpoint will delete users and all related user data identified by a set of emails, visitor IDs, or user IDs.

Purge requests default to being processed 10 days after submission, however this delay can be configured via the delaySeconds parameter. The endpoint is limited to 100 visitor deletions per request.

One of email, userId, or visitorId parameter is required to identify the user for data deletion.

post/v2/purge/visitors

Headers

Authorizationstring required

Bearer YOUR_API_KEY

Request body

delaySecondsinteger

Seconds to wait before starting visitor data purging. This can be used as a safety measure in case the request needs to be canceled.

emailsstring[]

List of emails for which visitor data will be purged.

userIdsstring[]

List of user IDs (external user IDs) for which visitor data will be purged.

visitorIdsstring[]

List of visitor IDs for which visitor data will be purged.

Response

requestIdstring