email, phone, sms. L’API vous permet de transmettre le consentement que vous avez recueilli, avec sa date et la mention affichée à la personne.
L’objet consent
Accepté sur POST /external-integration/contact et PATCH /external-integration/contact/{contactId}.
Ce qu’un canal absent de l’objet devient dépend de la route :
PATCH: il n’est pas modifié. Envoyezfalsepour retirer un consentement.POSTavec unjourney: il n’est pas modifié s’il n’est pas annoncé par ce parcours.POSTsansjourney: sur un nouveau contact, il est enregistré comme non consenti. Sur un contact déjà connu d’Avest (dédup), il n’est pas modifié : seul unfalseexplicite retire un consentement qu’il portait.
Date et mention obligatoires
Un canal est consenti quand il vauttrue, ou quand le journey déclaré l’annonce sans que vous l’ayez mis à false.
dateest obligatoire dès qu’au moins un canal est consenti. Unconsentqui ne fait que retirer des canaux (false) n’en demande pas.wordingText,wordingVersionetlocalesont obligatoires dès quephoneest consenti. Les trois parcours annoncent le téléphone : avec unjourney, ils sont donc requis, sauf si vous envoyez"phone": false. Pour le courriel et le SMS seuls, ils restent facultatifs, mais sont contrôlés s’ils sont transmis.
400 et rien n’est écrit : ni le contact (POST), ni ses modifications (PATCH).
Déclarer un parcours plutôt que lister les canaux
journey indique quelle mention la personne a vue. Les canaux que ce formulaire annonce deviennent consentis, sans avoir à les énumérer :
Les trois parcours annoncent les trois canaux. Un canal que le parcours n’annonce pas n’est pas écrit comme un refus : il est laissé intact.
Les booléens par canal restent prioritaires :
{ "journey": "acquisition", "sms": false } consent au courriel et au téléphone, et refuse le SMS.
journey n’est accepté qu’à la création. Sur PATCH, la requête est
rejetée : une mise à jour énonce chaque canal explicitement.Durées
- Téléphone : un an, fixé par la réglementation, sans reconduction tacite.
durationYearsne s’y applique pas. - Courriel et SMS : trois ans par défaut, ou la valeur de
durationYearssi vous la transmettez, à la création (POST) comme à la mise à jour (PATCH). Le réglage de durée de l’agence ne s’applique pas à un consentement transmis par l’API. durationYearsest un entier de 1 à 3 : c’est la plage acceptée par l’API. Toute autre valeur est rejetée (400) plutôt que silencieusement raccourcie : mieux vaut une erreur qu’un200cachant un consentement plus court que celui annoncé à la personne.- L’expiration du consentement se calcule à partir de
date, pas de l’instant de l’appel. - La fin de conservation du contact se calcule à partir de son accord le plus récent, tous canaux confondus (sa
datede recueil, et non l’instant de l’appel), plus la durée de conservation appliquée (voirretentionDurationYears). Un recueil ancien donne donc une fin de conservation proche, voire déjà passée. Un accord ignoré parce que déjà enregistré ne la prolonge pas.
Traçabilité
Chaque consentement pris en compte crée une entrée dans le journal d’audit du contact, avec sa source, sa date de recueil, la mention affichée (wordingText, wordingVersion, locale) et le contexte (details). Un canal ignoré parce que déjà enregistré n’y figure pas.
Un renvoi ignoré, comme le retrait d’un canal déjà retiré, n’écrit rien : si aucun autre canal ne change, PATCH renvoie consentChanged: false.
Un retrait du courriel arrête les séquences marketing du contact et l’exclut des campagnes courriel. Un retrait du SMS l’exclut des campagnes SMS. Un retrait ne coupe pas les messages liés à une transaction en cours, et les appels restent à l’initiative de l’agence, qui voit le retrait sur la fiche du contact.
Une opposition RGPD déjà enregistrée sur le contact survit à un consentement transmis par l’API : elle n’est jamais levée par cette route.
Exemples
Un partenaire qui a affiché la mention du formulaire acquéreur :Erreurs
L’API préfixe ces messages du nom de la route, par exemple
ExternalIntegrationCreateContact : consent.date is required when a channel is granted.