Postmark
Postmark API

Data Removal

Request removal of personal data (GDPR). Requires an account token.


Create a Data Removal request

POST
https://api.postmarkapp.com
/data-removals

Requests removal of the data held for an email address (GDPR). API access must be enabled for your account (error code 1302). Requires an account token.

Create a Data Removal request › Request Body

GDPR data removal request details.
RequestedBy
​string · email · required

Email address of the person making the request.

Example: requester@example.com
RequestedFor
​string · email · required

Email address whose data should be removed.

Example: subject@example.com
NotifyWhenCompleted
​boolean

Email RequestedBy when the removal completes.

Example: true

Create a Data Removal request › Responses

The request was created.

Status of a data removal request.
ID
​integer · required

Unique ID of the data removal request. Field of DataRemovalStatus.

Example: 1234
Status
​string · required

Current status of the request.

Example: Pending

Check a Data Removal request status

GET
https://api.postmarkapp.com
/data-removals/{removalId}

Returns the status of a data removal request. Requires an account token.

Check a Data Removal request status › path Parameters

removalId
​integer · required

Unique ID of the data removal request.

Check a Data Removal request status › Responses

The request status.

Status of a data removal request.
ID
​integer · required

Unique ID of the data removal request. Field of DataRemovalStatus.

Example: 1234
Status
​string · required

Current status of the request.

Example: Pending