URL https://api.dpmail.fr/json/Subscriber.ImportBatch.php
Permet d'importer un grand nombre de contacts dans une liste en une seule fois. Cette méthode devrait être appelée en utilisant la méthode POST à la place de GET. Le nombre maximal d'abonnés importés n'est pas fixé, cependant la taille raisonnable de chaque appel doit être d'environ 5000 à 10000 lignes. Ces appels peuvent être longs, mais ne doivent pas excéder 30 secondes, sinon vous recevrez un timeout.
Pour importer un grand nombre de contacts sans risquer de recevoir un timeout, vous pouvez utiliser Subscriber.ImportByUrl qui permet de réaliser des imports asynchrones.
Paramètres et infos requises
ListId - String
L'identifiant de la liste à laquelle ajouter les abonnés.
Batch - JsonString
Une chaine en JSON représentant un tableau d'objet. Voir la description ci-dessous.
Options - Array
Un tableau d'option permettant d'adapter le fonctionnement de l'import:
Options disponibles :
- update_existing (défaut: true) : Si l'adresse email existe déjà dans la liste, les données du contact seront mises à jour.
- resubscribe (défaut: false) : Si l'adresse email correspond a un contact désinscrit de la liste, il sera ré-inscrit.
Codes de retour
Succès
0: Success
Les données sont correctes, l'import va se réaliser d'ici quelques instants.
Erreur
11: Format JSON illisible
Le format JSON du paramètre Batch est illisible/indécodable.
301: ListID Invalide
ListID doit être une chaine de 32 caractères. La liste dans laquelle vous voulez importer les abonnés doit appartenir au compte lié à votre clé API.
316: Batch est vide
Le paramètre Batch a été reçu vide. Aucune action n'a été réalisée.
Format de données en entrée pour le paramètre "Batch"
[
{
"email" : "azer@uipo.tld",
"first_name" : "Bérenger",
"customs_fields" : {
"ville" : "Toulouse",
"codep" : 31000
}
}, {
"email" : "qwerty@uipo.tld",
"first_name" : "David",
"customs_fields" : {
"ville" : "Castres",
"codep" : 81100
}
}, ...
]Format des données en sortie
{
"add_count" : 613,
"adds" : [
"azer@uipo.tld",
"..."
],
"update_count" : 254,
"updates" : [
"qwerty@uipo.tld",
"..."
],
"error_count" : 0,
"errors" : []
}