​

Centre de préférences : la page publique d’opt-in/opt-out

Original anglais : Preference center: the public opt-in/opt-out page.

​

1. Configurer une fois : POST/GET /preference-center

​

Champs de configuration

​

Sujets d’abonnement

• name (1–120 caractères) — le nom affiché sur la page.
• description (optionnel, ≤500) — une ligne de contexte affichée près de la bascule.
• defaultOptIn (défaut false) — comment un contact sans préférence enregistrée est traité.
• archived (optionnel) — les sujets archivés restent dans la piste d’audit mais ne s’affichent plus sur la page.

​

2. Émettre un lien par contact

curl -X POST "https://api.orbit.devotel.io/api/v1/compliance/preference-center/link" \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "contactId": "cnt_01H…" }'

• Le lien vise la page hébergée, pas l’endpoint JSON. Copiez-le tel quel dans vos gabarits de pied/expéditeur ; la page elle-même interroge l’endpoint de données en coulisse.
• TTL de 30 jours. Passé ce délai, le jeton vérifie comme expiré et le contact doit demander un nouveau lien (en émettre un nouveau prend un appel API).
• La page est agnostique du locale à l’émission. L’app web résout une redirection en préservant la requête ?token=, vous n’avez donc pas à deviner le locale du contact.

​

Où le placer

• Envois marketing à corps libre : ajouté pour vous. Vous n’avez pas à placer le lien. Orbit ajoute une ligne {optOutMessage}: {link} à chaque envoi marketing à corps libre tant que votre centre de préférences est activé — sur sms et whatsapp via votre domaine court personnalisé, sur email et les autres canaux à corps libre sous forme de lien brut à jeton — et les envois gabarit sont ignorés. La même page décrit quand le pied apparaît, ce qu’écrit le clic ajouté et son lien avec la formule opérateur « Reply STOP » : voir Preference center: when Orbit appends the opt-out footer for you.
• Envois transactionnels et gabarit : à placer vous-même. Ces envois ne portent jamais le pied ajouté, donc le lien émis ci-dessus est leur voie de désabonnement en un geste : copiez-le tel quel dans la zone de désabonnement de vos gabarits e-mail, et rédigez-le dans les copies de gabarit ou les corps transactionnels où vous en voulez un. Émettre un lien court tracké pour un emplacement est optionnel ; si l’émission de lien court échoue, le lien brut fonctionne encore — le repli est additif, jamais structurel pour la conformité.
• Ré-opt-in piloté par la suppression. Quand un contact se réinscrit par un autre flux, vous pouvez lui remettre un lien frais pour qu’il retrouve la même page en libre-service.

​

3. La page publique à jeton

• GET /preferences/:token — renvoie le payload de la page.
• PUT /preferences/:token — applique les mises à jour.

​

Réponse GET

{
  "contactId": "cnt_01H…",
  "displayName": "…",
  "email": "m*****@example.com",      // masked
  "phone": "+15551****…",             // masked
  "channelPreferences": { "sms": "opted_in", "email": "opted_out" },
  "frequencyPreference": "all",
  "channels": ["sms", "email"],
  "topics": [ { "id": "newsletter", "name": "Newsletter", "defaultOptIn": false } ],
  "topicPreferences": { "newsletter": "opted_in" },
  "consentHistory": [
    { "channel": "all", "state": "opted_out", "topicId": "newsletter", "occurredAt": "2026-09-01T…" }
  ],
  "config": { /* the org's preference-center config */ }
}

​

Corps de requête PUT

{
  "channelPreferences": {
    "sms": "opted_in",
    "email": "opted_out"
  },
  "frequencyPreference": "important_only",
  "topicPreferences": { "newsletter": "opted_in" },
  "requestDataDeletion": false
}

• channelPreferences — map partielle permise (Zod partial-record) ; au moins un canal est requis.
• frequencyPreference — optionnel, parmi all, important_only, weekly_digest, monthly_digest.
• topicPreferences — map optionnelle { topicId: opted_in | opted_out } validée contre vos sujets configurés ; les ids inconnus sont ignorés.
• requestDataDeletion — pose une demande d’effacement GDPR parallèlement à l’opt-out (voir section 6).

​

4. Comment les mises à jour circulent

• Registre de consentements. Une ligne consent_records par canal (ou par sujet) est ajoutée avec source: preference_center — votre piste d’audit de charge de la preuve Art. 7 GDPR.
• Liste de suppression. Sur tout canal désactivé, le téléphone/e-mail normalisé du contact est inséré avec le périmètre all — un blocage inter-canaux que lit chaque porte d’envoi.
• Clôture STOP. Une clôture rapide Redis est posée à l’opt-out (et levée à un ré-opt-in complet), si bien que les lots de campagne en cours voient le changement avant que la suppression base de données, plus lente, ne se propage.
• Journal d’audit. compliance.preference_center_updated est consigné quand vous changez la configuration, et les événements d’opt-in/out au niveau contact sont capturés dans le registre de consentements.

​

5. Sémantique de la bascule d’effacement GDPR

​

6. Le tester

curl -X POST "https://api.orbit.devotel.io/api/v1/compliance/preference-center" \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "companyName": "Acme Logistics",
    "primaryColor": "#1d4ed8",
    "channels": ["sms", "email"],
    "headerText": "Manage how Acme contacts you",
    "topics": [
      { "id": "shipping-updates", "name": "Shipping updates", "defaultOptIn": true },
      { "id": "promotions", "name": "Promotions", "defaultOptIn": false }
    ]
  }'

LINK=$(curl -s -X POST "https://api.orbit.devotel.io/api/v1/compliance/preference-center/link" \
  -H "Authorization: Bearer $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contactId":"cnt_01H…"}' | jq -r '.link')

TOKEN="${LINK#*token=}"

curl -s "https://api.orbit.devotel.io/api/v1/compliance/preferences/$TOKEN" | jq

curl -s -X PUT "https://api.orbit.devotel.io/api/v1/compliance/preferences/$TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"channelPreferences":{"sms":"opted_out"}}' | jq

​

Related

• Send gates et gardes pré-envoi — où le résumé du centre de préférences côtoie les heures de silence, l’arrêt d’urgence et les limiteurs.
• Listes d’opt-out et de suppression — comment le périmètre all et les imports CSV en masse se rapportent à cette surface.
• Gestion du consentement — l’API côté opérateur qui stocke le même registre de consentements.
• Référence DSAR — le pipeline d’effacement tracké vers lequel acheminer les demandes requestDataDeletion.