Notify API reference

Notify API · Recipients

delete/v1/workspaces/{workspace_id}/recipients/{external_id}Auth

Erase a recipient (GDPR)

Deletes the recipient and everything Notify holds for it: devices now, and preferences, inbox items and pending deliveries as those land. Delivery history keeps ids and states but loses addresses and rendered text. The data is gone when this returns; the external id can be used again. Email already handed to ProductCraft Mail stays in Mail's message log under Mail's retention.

Path parameters

workspace_id*string · uuid

Id of the workspace.

external_id*string

Your user id for the recipient (URL-encoded): 1-255 of `A-Z a-z 0-9 . _ : @ | -`.

Response · 202 Erased.

id*string · uuid

The erased recipient id.

external_id*string

The erased external id; it can be used again for a new recipient.

Example: "user_123"

status*object

Always `erased`: the data is gone when this returns.

Example

Request

DELETE https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/recipients/{external_id}
Authorization: Bearer YOUR_TOKEN

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "external_id": "user_123",
  "status": {}
}