Perform the unsubscribe (form submit or RFC 8058 one-click)

Executes the unsubscribe: writes a marketing suppression and records marketing consent as revoked. Serves both the confirm-button form submit and a mail client’s RFC 8058 List-Unsubscribe-Post one-click POST.

When the Accept header does NOT include text/html (mail-client one-click), responds with plain-text OK; otherwise returns an HTML “unsubscribed” page.

Auth: none (signed token in path).

Parameters

Path Parameters

token

required

string

HMAC-signed compliance token identifying (projectId, emailHash).

Responses

200

Unsubscribe recorded. HTML page for browsers; plain-text OK for RFC 8058 one-click clients (non-HTML Accept).

string

400

Missing/expired/invalid token, service misconfigured, or recipient not found for the token’s email hash. HTML error page.

text/html

string

POST

/api/email/unsubscribe/{token}

1
curl --request POST \
2
  --url https://api.retidal.com/api/email/unsubscribe/%3Cstring%3E

1
const url = 'https://api.retidal.com/api/email/unsubscribe/%3Cstring%3E';
2
const options = {method: 'POST'};
3

4
try {
5
  const response = await fetch(url, options);
6
  const data = await response.json();
7
  console.log(data);
8
} catch (error) {
9
  console.error(error);
10
}

1
package main
2

3
import (
4
  "fmt"
5
  "net/http"
6
  "io"
7
)
8

9
func main() {
10

11
  url := "https://api.retidal.com/api/email/unsubscribe/%3Cstring%3E"
12

13
  req, _ := http.NewRequest("POST", url, nil)
14

15
  res, _ := http.DefaultClient.Do(req)
16

17
  defer res.Body.Close()
18
  body, _ := io.ReadAll(res.Body)
19

20
  fmt.Println(res)
21
  fmt.Println(string(body))
22

23
}

200Unsubscribe recorded. HTML page for browsers; plain-text OK for RFC 8058 one-click clients (non-HTML Accept).

1
OK