/list/import
Parámetros | ||
---|---|---|
Nombre | Descripción | Formato |
list_id string |
ID de list. | String alfanumérico. |
data string |
Contenido de la lista. (Opcional). | String. |
url string |
URL en donde se encuentra el contenido de la lista. (Opcional). | String | URL. |
cols string |
String con el orden de las columnas, separadas por coma. (Opcional). | String con comas. |
data file |
Archivo adjunto con la lista. | Archivo. |
Valores de retorno | |
---|---|
status | “queued”. |
queuedID | ID del proceso de importación. |
Cols | Array con los campos utilizados en la lista. |
Códigos de error | |
---|---|
U02401D | No se encontró la lista con el list_id indicado. |
U02601I | No se proporciono el contenido de la lista. |
U02606I | El formato de compresión no es válido. |
U02602I | No se definió la columna “email”. |
U02604I | No se pudo acceder a la URL. |
U02604I | No se pudo acceder al contenido de la lista. Es posible que esto sea un error interno. |
Métodos para cargar los datos
Es posible cargar el contenido de la lista de diferentes métodos.
El parámetro “data” puede ser un string o un file. En caso de que sea un string, este puede esta comprimido en formato GZip. El sistema detectará automáticamente la compresión.
La segunda forma de obtener el contenido de la lista es vía URL. Si la lista esta alojada en algún servidor externo, puede indicar la URL en este parámetro.
“data” y “url” son opcionales, pero al menos uno de los 2 debe especificarse.
Si quisiera enviar la lista en un archivo adjunto, debe enviar un archivo (y solo uno) con el nombre “data”.
Retorno
Cuando el proceso finalice, recibirá un status “queued”. Esto significa que el proceso de importación se va a realizar en segundo plano debido a que puede demorar varios minutos según el tamaño de la lista. Con el valor retornado en “queuedID” podrá consultar el estado de importación de la lista.