Documentation détaillée
Généralités
Authentification
Étapes de création d'un envoi e-mail
Étapes de création d'un envoi SMS
Nouveautés
administration du compte
abonnements
consentements
groupes d'intérêts
intérêts
champs
imports - mapping
imports de contacts
variables
ciblages
lois ciblages
critères ciblages
plannings
e-mail - adresses d'expéditeurs
e-mail - adresses de réponses
e-mail - liens de messages
e-mail - messages
e-mail - envois
e-mail - envois transactionnels
e-mail - A/B test
sms - expéditeurs
sms - messages
sms - envois
sms - envois transactionnels
exports - mappings
exports - colonnes
exports - filtres
exports
statistiques
hébergement
webhooks
connexions distantes
consentements - dépréciées
imports de contacts - dépréciées
Powered by Stoplight
post

/contacts/read

Recherche un contact à partir de sa clé d’unicité.

Renseigner en paramètre de la requête :

  • AccountID (*) : l’identifiant du compte

Puis dans le corps de la requête :

  • FieldValueList (*) : la liste des identifiants de champs du contact qui compose la clé d’unicité avec :
    • ID (*) : l’identifiant du champ clé d’unicité du contact (généralement ID=7 pour le champ e-mail)
    • Value (*) : l’e-mail du contact recherché ou la valeur de sa clé d’unicité

Vous pouvez également définir les champs de contacts retournés dans la réponse, en renseignant la propriété suivante :

Cette méthode permet de récupérer les valeurs des champs d’un contact comme :

  • ID : l’identifiant du contact
  • SalutationID : l’identifiant de sa civilité
  • CountryID : l’identifiant de son pays
  • Optin : l’optin du contact (inscrit oui ou non aux newsletters)
  • UpdateDate : la dernière date de mise à jour du contact au format ISO 8601
  • SubscribeDate : la date d’inscription d’abonnement global au format ISO 8601
  • UnsubscribeDate : la date de désabonnement global si elle existe au format ISO 8601
  • SMSUnsubscribeDate : la date de désabonnement SMS si elle existe au format ISO 8601
  • ou n’importe quel autre champ du contact à renseigner dans OutputFieldIDList à partir de sa clé d’unicité.

Pour des raisons de performances et d’optimisation des ressources de l’API, lors d’une recherche d’un contact dont vous connaissez l’e-mail (ou la clé d’unicité), merci de privilégier cette méthode à la méthode de recherche des contacts.

(*) : paramètres obligatoires

Dernière mise à jour : Mai 2021

Authorization

apiKey - X-API-Key

Request Parameters

1 Query Parameter
1 Header

Request Body

1 Example
Schema
object

Contact management

Query
object

ReadQuery

Responses

Contact retrieved.

Schema
object

DetailedContact

ID
integer
2 validations
SubscribeDate
string
2 validations
UpdateDate
string
2 validations
UnsubscribeDate
string
2 validations
SmsUnsubscribeDate
string
2 validations
RentBalanceMobile
integer
1 validation
RentBalance
integer
1 validation
FieldList
array[object]

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
X-API-Key