Update email consent preferences

Updates per-category consent (granted/revoked). Accepts either an HTML form POST (application/x-www-form-urlencoded) or application/json, with category_<name> fields (truthy = subscribed). Revoking marketing also writes a suppression; re-subscribing does NOT clear bounce/complaint suppressions. Returns an HTML “saved” page.

Auth: none (signed token in path).

Parameters

Path Parameters

token

required

string

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

Request Body

Per-category checkbox state. Form-encoded (browser form) or JSON. Each category_<name> key that is truthy marks that category subscribed.

object

key

additional properties

any

Example

1
{
2
  "category_marketing": "1"
3
}

object

key

additional properties

any

Example

1
{
2
  "category_marketing": true,
3
  "category_transactional": true
4
}

Responses

200

Preferences saved (HTML page).

text/html

string

400

Missing/expired/invalid token or service misconfigured. HTML error page.

text/html

string

POST

/api/email/preferences/{token}

1
curl --request POST \
2
  --url https://api.retidal.com/api/email/preferences/%3Cstring%3E \
3
  --header 'Content-Type: application/json' \
4
  --data '{
5
  "category_marketing": true,
6
  "category_transactional": true
7
}'

1
const url = 'https://api.retidal.com/api/email/preferences/%3Cstring%3E';
2
const options = {
3
  method: 'POST',
4
  headers: {'Content-Type': 'application/json'},
5
  body: '{"category_marketing":true,"category_transactional":true}'
6
};
7

8
try {
9
  const response = await fetch(url, options);
10
  const data = await response.json();
11
  console.log(data);
12
} catch (error) {
13
  console.error(error);
14
}

1
import requests
2

3
url = "https://api.retidal.com/api/email/preferences/%3Cstring%3E"
4

5
payload = {
6
    "category_marketing": True,
7
    "category_transactional": True
8
}
9
headers = {"Content-Type": "application/json"}
10

11
response = requests.post(url, json=payload, headers=headers)
12

13
print(response.json())

1
import httpx
2
import json
3

4
url = "https://api.retidal.com/api/email/preferences/%3Cstring%3E"
5

6
payload = json.loads("{\n  \"category_marketing\": true,\n  \"category_transactional\": true\n}")
7

8
response = httpx.post(url, json=payload)
9

10
print(response.json())

1
package main
2

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

10
func main() {
11

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

14
  payload := strings.NewReader("{\n  \"category_marketing\": true,\n  \"category_transactional\": true\n}")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("Content-Type", "application/json")
19

20
  res, _ := http.DefaultClient.Do(req)
21

22
  defer res.Body.Close()
23
  body, _ := io.ReadAll(res.Body)
24

25
  fmt.Println(res)
26
  fmt.Println(string(body))
27

28
}