Importations

POST /api/v1/lists/(int: list_id)/imports

Importe le fichier CSV téléversé en tant qu’abonnés à la liste spécifiée.

Parameters:

• list_id (int) – l’identifiant unique de la liste

Form Parameters:  

• file – le fichier CSV contenant les abonnés
• encoding – l’encodage du fichier, s’il n’est pas spécifié il sera détecté automatiquement
• delimiter – le délimiteur de colonnes, s’il n’est pas spécifié il sera détecté automatiquement
• has_header – signale la présence ou l’absence d’un entête, la présence sera détectée automatiquement si le paramètre n’est pas spécifié
• ignore_invalid_fields – détermine la manière dont les colonnes contenant des données invalides doivent être traitées
• date_format – le format strptime utilisé pour représenter les dates
• fields – association des index de colonnes du fichier aux champs des abonnés

Si le paramètre fields n’est pas fourni vous devez assigner la valeur true au paramètre has_header afin que la première ligne du fichier soit considérée comme l’entête associant les colonnes aux champs des abonnés.

subscribers.csv

email	first_name	gender	language
alice@domain.com	Alice	f	fr
bob@example.com	Bob	m	en

Requête:

POST /api/v1/lists/1/imports HTTP/1.1
Host: account.emailicious.com
Accept: application/json
Content-Type: multipart/form-data; boundary=------------------------aefc77a7a0e120e9

Réponse:

HTTP/1.1 201 CREATED
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json

{
    "id": 1,
    "file": "subscribers.csv",
    "encoding": "utf-8",
    "delimiter": ",",
    "has_header": true,
    "ignore_invalid_fields": true,
    "date_format": "%d-%m-%Y",
    "fields": [
        "email",
        "first_name",
        "gender",
        "language"
    ]
}

Status Codes:

• 201 Created – l’importation a été crée avec succès
• 400 Bad Request – données d’importation invalides
• 404 Not Found – aucune liste d’abonnés ne correspond au list_id spécifié