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
contacts
abonnements
consentements
groupes d'intérêts
intérêts
champs
imports - mapping
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

/imports/contacts

Crée un nouvel import de contacts.

Un import de contacts est un fichier (txt, csv ou Excel) qui contient des informations sur vos contacts (e-mail, prénom, nom etc.). Ce fichier doit être déposé sur votre hébergement FTP Dolist dans le répertoire upload/contact.

Attention, la création d’un mapping d’import est indispensable avant de pouvoir créer un import de contacts.

Renseigner dans les paramètres de la requête :

  • AccountID (*) : l’identifiant du compte Campaign

Puis dans le corps de la requête :

  • Name (*) : nom que vous souhaitez donner à l’import (256 caractères maximum
  • SegmentNamePrefix : préfixe utilisé pour crée automatiquement un ciblage contenant tous les contacts importés. Si non renseigné aucun ciblage ne sera créé
  • MappingID (*) : identifiant du mapping d’import de contacts
  • Pattern (*) : une expression régulière qui permet de détecter votre fichier d’import de contacts déposé dans le repertoire /upload/contact sur votre hébergement Dolist. Exemple : ^pr-contacts.*\.csv$ : tous les fichiers au format .csv dont le nom débute par “pr-contacts” seront consommés par l’API
  • Optout (*) : pour définir le statut des contacts. (Actifs : 0, Désabonnés : 1, Injoignables : 2)
  • ContactUpdate (*) : booléen pour mettre à jour les champs des contacts. Si les contacts importés sont existants dans la base, cela remplacera la valeur du fichier dans la base, et mettra à jour le contact (renseigner true). Si vous ne souhaitez pas mettre à jour vos contacts déjà présents en base avec les informations de votre fichier d’import renseigner false
  • CountryCode : indicatif téléphonique international du pays

Lorsque votre import sera en place, vous pourrez venir déposer autant de fichiers que nécessaire et ainsi automatiser la synchronisation de vos contacts dans Campaign.

(*) : paramètres obligatoires

Dernière mise à jour : Mai 2021

Authorization

apiKey - X-API-Key

Request Parameters

1 Query Parameter
1 Header

Request Body

Schema
object

Import management

Import
object

ContactImport

Responses

Success

Schema
object

PostResult

ID
integer
2 validations

Send a Test Request

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