Erase captured emails - uploadthefile API documentation

Erase the emails captured by the page's email gate (data-subject erasure,
GDPR Art 17). Send { "email": "…" } to erase a single address, or
{ "all": true } to erase every capture for the page. Owner-scoped; you can
only erase captures for a page you own. Returns the number of rows removed.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Captures erased. deleted is the number of rows removed (0 when no capture
matched the address). A 0 here means "no matching row", never a failed delete:
a store failure is a 500, so a 200 is a truthful confirmation of erasure.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429

🔴500Server Error

curl --location --request DELETE 'https://upload.tf/api/v1/pages/mysite/captures' \ --header 'x-api-key: <api-key>' \ --header 'Content-Type: application/json' \ --data-raw '{ "email": "user@example.com", "all": true }'