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
get

/imports/contacts/importjobs

Récupère tous les détails des imports de contacts ainsi que toutes leurs occurences dépendantes.

Une occurrence d’import correspond au job d’exécution de votre import de contacts. A chaque exécution de l’import, un identifiant d’occurrence sera généré qu’il sera nécessaire de passer à la méthode /imports/contacts/jobs/{JobID} afin de pouvoir récupérer les détails de l’occurence d’import de contacts.

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

  • AccountID (*) : identifiant du compte Campaign
  • JobPerImport (*) : nombre maximum d’occurrences d’imports de contacts (doit être supérieur à 0) En précisant seulement ces 2 paramètres, vous récupèrerez l’intégralité des imports de contacts effectués ainsi que toutes leurs occurrences.

Vous pouvez filtrer les résultats en renseignant :

  • MappingID : l’identifiant du mapping de l’import de contacts
  • SearchValue (*) : chaîne d’au moins 1 caractére. La valeur sera comparée au nom Name de l’import de contacts ou à l’identifiant de l’occurrence de l’import de contacts. (obligatoire si ImportID non renseignée)
  • Filter : All, ManualOnly, AutoOnly

Enfin, utiliser les paramètres :

  • SortField : pour trier les réponses en précisant le champ sur lequel le tri sera effectué et SortOrder pour préciser le sens (ASC ou DESC)
  • limit et l’offset pour paginer les réponses

Cette méthode retourne :

  • les propriétés de chaque import de contacts comme :
    • Name : nom de l’import
    • SegmentNamePrefix : préfixe utilisé pour crée automatiquement un ciblage contenant tous les contacts importés
    • MappingID : identifiant du mapping d’import de contacts
    • Pattern : expression régulière qui permet de détecter votre fichier d’import de contacts
    • Optout : statut des contacts
    • ContactUpdate : booléen pour mettre à jour les champs des contacts.
    • CountryCode : indicatif téléphonique internationnal du pays
    • CreateDate : date et heure de création de l’import de contacts au format ISO 8601
    • UpdateDate : date et heure de dernière mise à jour de l’import de contacts au format ISO 8601
    • ExecuteDate : date et heure de dernière exécution de l’import de contacts au format ISO 8601
    • ImportID : identifiant de l’import de contacts
    • Name : nom de l’import
    • MappingID : identifiant du mapping de l’import de contacts
  • ainsi que les propriétés de chaque occurrence d’import de contacts comme :
    • ID : identifiant de l’occurrence d’import de contacts
    • CreateDate : date de création de l’occurrence d’import au format ISO 8601
    • UpdateDate : date de dernière mise à jour de l’occurrence d’import au format ISO 8601
    • ExecuteDate : date de dernière exécution de l’occurrence d’import au format ISO 8601
    • OriginalFileName : nom du fichier de chargement
    • Status : statut de l’occurrence d’import
    • NewContacts : nombre de nouveaux contacts
    • ExistingContacts : nombre de contacts existants
Dernière mise à jour : Mai 2021

Authorization

apiKey - X-API-Key

Request Parameters

9 Query Parameters
1 Header

Responses

Contact imports with jobs retrieved.

Schema
object

DetailedList

Count
integer

Returned elements.

2 validations + required
Total
integer

Total elements (without filters).

2 validations + required
ItemList
array[object]

Items.

required

Send a Test Request

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