Requests

A Request represents a single user deletion across the integrations connected to a workspace.

Required fields

Identifier

The identifier uniquely references the user in your downstream tools (for example: email, user ID, external ID, distinct ID). Each Request contains exactly one identifier. If a user must be deleted across multiple identifiers, submit multiple Requests, one per identifier.

Workspace / Workspace Key

Requests are scoped to a workspace. In the UI, you select the workspace. Via the API, you provide the workspaceKey. This tells Forget API which group of integrations to route the Request to.

What happens after submission

Forget API looks up all integrations attached to the target workspace.
Sub-requests are created, one per attached and enabled integration.
Each integration receives a deletion request for the respective identifier.
Progress is tracked per sub-request and rolled up to the parent Request.

Statuses

Statuses reflect the state of each sub-request and are surfaced in the UI and API. Note that depending on the integration, only some (or all) of the statuses may be applicable:

STAGING: Forget API is preparing and dispatching the Request to the attached integrations.
PENDING: The Request was sent and is waiting on the destination; or it is scheduled for deletion (e.g., warehousing/database jobs).
PROCESSING: The destination is actively processing the deletion. Duration varies by integration.
SUCCESS: The destination confirmed successful deletion for this identifier.
CANCELED: The Request was canceled by a member in the organization. Only some integrations support cancellation.
FAILED: An error occurred when sending or executing the deletion with an integration (commonly auth or integration-specific errors). These can typically be retried.
ERROR: An internal error occurred within Forget API while handling the Request.

Monitoring and control

View Request details to monitor per-integration status and audit logs over time.
Manually check the status of a Request.
Cancel a Request where the destination supports cancellation.

Data retention

After all sub-requests complete, Forget API applies your workspace’s data retention policy. Depending on your configuration, Request details will be hashed or permanently deleted after the defined retention period.