Passer au contenu principal
PATCH
Mettre à jour un contact

Autorisations

Authorization
string
header
requis

Token LinkedAPI avec scope externalIntegration. La clé doit avoir un agencyGroup configuré (sinon 400 LinkedAPI agencyGroup is required). Fourni via l'en-tête Authorization: Bearer {linkedAPI_token}. Si la clé a secure === true, l'IP appelante doit être whitelistée (en-tête X-Real-IP), sinon 403 Not authorized to access this resource.

La clé porte aussi un niveau d'accès : en lecture seule, elle n'autorise que les GET ; un POST ou un PATCH renvoie alors 403 Not authorized to access this resource, soit la même réponse qu'une requête sans en-tête Authorization. Voir le guide Authentification.

Paramètres de chemin

contactId
string
requis

ObjectId du contact à mettre à jour. Identifiant Mongo (24 caractères hexadécimaux).

Pattern: ^[a-fA-F0-9]{24}$
Exemple:

"618a35a36d932054e195ca0a"

Corps

application/json

Au moins un champ doit être fourni : un objet consent seul suffit. Les coordonnées (email / téléphone) ne sont pas modifiables via cette route.

firstName
string
lastName
string
title
enum<string>
Options disponibles:
mr,
mme
commercialName
string
corporateName
string
siren
string
website
string
address
string

Consentement à la prospection que vous avez recueilli, par canal. Un canal consenti exige date ; phone consenti exige aussi wordingText, wordingVersion et locale (sinon 400). Ne transmettez true que pour un nouvel accord : sur un canal encore consenti, il n'est enregistré que si date est postérieure au recueil déjà enregistré ; sur un canal retiré depuis, il rétablit le consentement. Un canal absent n'est pas modifié. Voir le guide Consentement à la prospection.

Réponse

Contact mis à jour.

success
boolean
contact
object

Contact. firstName / lastName si isIndividual: true ; commercialName / corporateName si entreprise (isIndividual: false).

Présent quand la requête porte un objet consent. false quand rien n'a été écrit : retirer un canal déjà retiré, ou renvoyer, sur un canal encore consenti, un consentement sans date de recueil plus récente.