ATTRIBUTE_UPDATE) visible sur la fiche.
Endpoint
URL :/external-integration/contact/{contactId}
Méthode : PATCH
Authentification : Requiert un token LinkedAPI avec scope externalIntegration.
Clé requise : lecture-écriture. Une clé en lecture seule reçoit 403. Voir Types de clé.
L’autorisation
PATCH doit être activée sur le scope externalIntegration de
votre clé. Une clé en lecture seule reçoit 403 Not authorized to access this resource — la même réponse qu’un header Authorization absent. Contactez
Avest si vous recevez un 403 alors que la lecture fonctionne.Headers
Path Parameters
Body Parameters
Au moins un champ doit être fourni. Seuls les champs listés sont modifiables.Consentement
Unconsent seul suffit à constituer une requête valide. Chaque canal (email, phone, sms) est énoncé explicitement : true accorde, false retire, un canal absent n’est pas touché. Un true exige date ; "phone": true exige aussi la mention affichée (wordingText, wordingVersion, locale). Sans elles, toute la requête est refusée (400) et rien n’est modifié, pas même les champs d’identité qu’elle porte. Un retrait seul (false) n’exige ni date ni mention.
true que pour un nouvel accord de la personne. Sur un canal encore consenti, un true n’est enregistré que si sa date est postérieure à celle du recueil déjà enregistré ; sinon il est ignoré et ne prolonge rien. Sur un canal retiré depuis, le même true rétablit le consentement : ne renvoyez pas un consentement déjà transmis, et n’envoyez true sur un canal retiré que pour un accord donné par la personne après son retrait. La mention reste exigée pour "phone": true, même quand l’accord est ignoré.
La réponse porte consentChanged. Un renvoi ignoré, comme le retrait d’un canal déjà retiré, n’écrit rien : si aucun autre canal ne change, consentChanged vaut false.
consent.journey n’est accepté qu’à la création — ici la requête est
rejetée. Une mise à jour énonce chaque canal.Audit
Chaque champ modifié crée une activitéATTRIBUTE_UPDATE sur la fiche (consultable via GET /external-integration/activities?document={contactId}&documentType=contact). L’activité n’est pas attribuée à un collaborateur (origine API externe).
Exemple de requête
Réponse de succès
Code :200
Réponses d’erreur
contactIdinvalide :400 Bad Request
- Aucun champ modifiable fourni :
400 Bad Request
- Contact introuvable ou hors périmètre :
400 Bad Request
- Contact supprimé définitivement :
409 Conflict, quand leconsentde la requête modifierait la fiche.
- Header
Authorizationabsent, clé en lecture seule, ou IP non whitelistée sur une clé sécurisée :403 Not authorized to access this resource
- Token invalide :
401 Invalid bearer token
Rate limits
100 req / minute par groupe d’agences (un compteur par groupe d’agences × route : les autres routes d’écriture ont chacune le leur). Dépassement →429 Too Many Requests.