Unsubscribing a recipient. Also the one-click target of the `List-Unsubscribe` header (RFC 8058), so any body unsubscribes, except the form field `action=resubscribe`, which the result page's button posts to undo it.

POST

/reports/unsubscribe/{token}

const url = 'https://api.siteqwality.com/reports/unsubscribe/example';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/x-www-form-urlencoded'},
  body: new URLSearchParams('')
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.siteqwality.com/reports/unsubscribe/example \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data ''

An outside address that unsubscribes also opts out of the account’s other reports: the account cannot add it again until it resubscribes. A team member’s unsubscribe covers this schedule only.

Parameters

Path Parameters

token

required

string

Token from a report email

Request Body

Optional. action=resubscribe undoes an unsubscribe; any other body unsubscribes.

application/x-www-form-urlencoded

string | null

Responses

200

Unsubscribed, or resubscribed (HTML result page)

text/html

404

Unknown link. Nothing is changed.

text/html

500

The link could not be processed

text/html