PilotFoxDocs

Unsubscribe from an email report

POST
/api/v1/reports/unsubscribe

RFC 8058 one-click unsubscribe: the token in the URL is the whole authorization; the form body mail clients send (List-Unsubscribe=One-Click) is read and ignored. 400 for an invalid link.

Public: no credential needed.

Query Parameters

token*string
Length1 <= length <= 256

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X POST 'https://pilotfox.app/api/v1/reports/unsubscribe?token=string'
Example Response200
{  "data": {    "unsubscribed": true  }}