​

Centre de préférences : page publique 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 à côté 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 n’apparaissent plus sur la page.

​

2. Créer 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 cible la page hébergée, pas le point d’accès JSON. Copiez-le tel quel dans vos gabarits de pied de page/expéditeur ; la page elle-même récupère le point d’accès aux données en arrière-plan.
• TTL de 30 jours. Ensuite, le jeton se vérifie comme expiré et le contact doit demander un nouveau lien (en créer un nouveau prend un appel API).
• La page est indépendante de la locale au moment de la création. L’application web résout une redirection tout en conservant la requête ?token=, vous n’avez donc pas à deviner la locale du contact.

​

Où le placer

• Pied de page e-mail (principal). Ajoutez le lien généré (ou la variante courte tracée utilisée par votre expéditeur) dans la zone de désinscription des gabarits marketing.
• Secours SMS / WhatsApp. Lorsque le message n’a pas de bloc de pied de page, ajoutez le lien en ligne : {optOutMessage}: {link}. L’assistant qui construit les corps sortants accepte un lien court pré-créé, de sorte que votre clic de désinscription reçoit toujours l’attribution normale des clics.
• Retour opt-in piloté par suppression. Lorsqu’un contact se ré-opt-in via un autre flux, vous pouvez lui donner un lien frais pour qu’il obtienne la même page en libre-service.

​

3. La page publique à jeton

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

​

Réponse GET

{
  "contactId": "cnt_01H…",
  "displayName": "…",
  "email": "m*****@example.com",
  "phone": "+15551****…",
  "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": { /* la configuration du centre de préférences de l'organisation */ }
}

​

Corps de requête PUT

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

• channelPreferences — carte partielle autorisée (Zod enregistrement partiel) ; au moins un canal requis.
• frequencyPreference — optionnel, l’un de all, important_only, weekly_digest, monthly_digest.
• topicPreferences — carte { topicId: opted_in | opted_out } optionnelle validée par rapport à vos sujets configurés ; les id inconnus sont ignorés.
• requestDataDeletion — définit une demande de suppression GDPR à côté de l’opt-out (voir section 6).

​

4. Comment les mises à jour circulent

• Registre de consentement. 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 GDPR Article 7.
• Liste de suppression. Sur tout canal opt-out, le téléphone/e-mail canonique du contact est inséré avec le scope all — un bloc intercanal que chaque porte d’envoi lit.
• Clôture STOP. Une clôture de chemin rapide Redis est mise en place à l’opt-out (et supprimée lors d’un retour opt-in complet), de sorte que les lots de campagnes en vol voient le changement avant que la suppression de base de données plus lente ne se propage.
• Journal d’audit. compliance.preference_center_updated est enregistré lorsque vous modifiez la configuration, et les événements opt-in/out au niveau du contact sont capturés dans le registre de consentement.

​

5. Sémantique de la bascule de suppression GDPR

​

6. La 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

​

Liens connexes

• Barrières d’envoi et gardes pré-envoi — où vit le résumé du centre de préférences aux côtés des heures de silence, de l’arrêt d’urgence et des limitations.
• Opt-Out & Listes de suppression — comment le scope all et les importations CSV en vrac se rapportent à cette surface.
• Gestion du consentement — l’API côté opérateur qui stocke le même registre de consentement.
• Référence DSAR — la pipeline d’effacement suivie dans laquelle router les demandes requestDataDeletion.