Utilice la API bulk Contact Importer

Con ActiveCampaign, puede usar la API Bulk Contact Importer para cargar un gran número de contactos en su cuenta con una sola llamada a la API.

Tome nota

  • La API de importador de contactos masivos está disponible en todos los planes ActiveCampaign
  • Esta característica es para usuarios avanzados que están familiarizados con la API y se sienten cómodos al usarlo para importar contactos

Acerca de la API de importador de contactos a granel

El importador de contactos a granel está diseñado para realizar operaciones en grandes cantidades de contactos a la vez. Estas operaciones incluyen:

  • Creación de nuevos contactos
  • Actualización de contactos existentes
  • Establecer campos en los contactos
  • Etiquetado de contactos
  • Agregar contactos a las listas

NOTA

El importador de contactos masivos no está diseñado para admitir operaciones frecuentes que impliquen un pequeño número de contactos o para sincronizar actualizaciones en tiempo real desde una base de datos externa. En su lugar, las actualizaciones de contacto deben recopilarse en lotes más grandes e importarse como un grupo. Los contactos se pueden importar en lotes de hasta 250 artículos.

Si necesita cargar 10 o menos contactos a la vez, utilice la funcionalidad Contactos de nuestra API ActiveCampaign V3.  

Limitación de velocidad

El proceso de importador a granel está optimizado para la carga de listas más grandes de contactos. La ejecución de solicitudes frecuentes que implican un pequeño número de contactos requiere una sobrecarga significativa y puede afectar al rendimiento del importador’s. Como resultado, aplicamos los siguientes límites de tarifas en la API de importador de contactos masivos:

  • Para las solicitudes que contienen un solo contacto, hay un límite de 20 solicitudes por minuto
  • Para las solicitudes que contienen varios contactos, hay un límite de 100 solicitudes por minuto

Se recomienda que todos los usuarios intenten procesar por lotes las actualizaciones en grupos lo más grandes posible antes de iniciar una importación.

Limitación del tamaño de la carga útil

El tamaño máximo de carga útil de una sola solicitud de bulk_import es de 400000 bytes.

Contactos omitidos

Los contactos deben cumplir todos los criterios siguientes para poder crearse o actualizarse con esta API:

  • Es posible que los contactos importados no excedan el límite de su cuenta
  • El contacto debe tener una dirección de correo electrónico
  • La dirección de correo electrónico de contact’s no debe estar en una lista de exclusión
  • El correo electrónico contact’s no debe estar en una lista de direcciones de correo electrónico rebotadas
  • El contacto no debe haber cancelado la suscripción a una lista a la que la importación los agregaría

Si los contactos no cumplen todos estos requisitos, el importador los omitirá.

Documentación de API

POST https://youraccountname.api-us1.com/api/3/import/bulk_import

Estructura de la solicitud

JSON
•
Contactos:
    •
        "email": "someone@somewhere.com",
        Nombre Jane
        "last_name": "Doe",
        Teléfono 5
		"customer_acct_name": ActiveCampaign
        Etiquetas
            		"dictumst aliquam augue quam sollicitudin rutrum",
        		•
        "fields": [
"id": 1, "value": "foo",,
"id": 2,"value": "foo|| bar|| baz"
        •
        "subscribe": ["listid": 1o, "listid": 2
        "unsubscribe": ["listid": 3
    •
•
"callback": <opcional, véase más adelante>
•

Respuesta
200 OK
•
Éxito:
"queued_contacts":1,
"batchId":"0641fbdd-f62f-4c2c-ba02-3a83d5d11ac9",
"message":" Póngase en contacto con importd"
•
 
400 Solicitud incorrecta
•
Éxito:
"message":" La carga JSON no pasó la validación. Corrija failureReasons y vuelva a intentarlo. La importación no se puso en cola para su procesamiento.",
"failureReasons":[" La carga útil debe contener un campo 'contactos'"]
}

 

Params Corporales

Matriz contacts* (objeto)

Matriz de objetos que contiene información sobre un único contacto. Se pueden incluir hasta 250 contactos en una sola solicitud. Cada contacto puede contener los siguientes campos:

  • correo electrónico* (cadena)
    El correo electrónico contact’s.
  • first_name (cadena)
    El nombre del contact’s.
  • last_name (cadena)
    El apellido contact’s.
  • teléfono (cadena)
    El número de teléfono de contact’s.
  • customer_acct_name (cadena)
    El nombre de la cuenta contact’s.
  • Matriz de etiquetas (cadena)
    Cada cadena de la matriz se agregará como una sola etiqueta al contacto. Se crearán nuevas etiquetas si aún no existen.
  • Matriz de campos (objeto)
    Una lista de campos personalizados para aplicar al contacto. Cada campo debe contener dos campos: Cada contacto puede tener hasta N campos personalizados.
  • id*   (número)
    El identificador del campo personalizado. El identificador que ActiveCampaign les asigna debe hacer referencia a los campos personalizados. Puede recuperar el número de ID de un campo personalizado mediante la llamada a la API "Listar todos los campos personalizados".
  • valor*   (cadena)
    El valor del campo personalizado. Se pueden rellenar varios valores para campos de varios valores separando los diferentes valores por el delimitador de doble tubería (“||”).
  • Matriz de suscripción (objeto)
    Una matriz de listas a las que suscribirse al contacto. Es posible que los contactos no se suscriban a listas de las que han cancelado su suscripción anteriormente. Cada objeto de lista contiene un único campo.
  • listid* (número)
    El ID de la lista a la que suscribirse al contacto. El identificador que ActiveCampaign les asigna debe hacer referencia a las listas.

    Puede encontrar el ID de lista haciendo clic en la lista en su cuenta ActiveCampaign y luego viendo la barra de URL. Se verá algo como esto: /app/contacts/? listid-19&status-1

    También puede recuperar el número de ID de una lista mediante la llamada a la API "Recuperar todas las listas".
  • matriz   de cancelación de suscripción (objeto)
    Una matriz de listas a las que cancelar la suscripción al contacto. Cada objeto de lista contiene un único campo.
  • listid*   (número)
    El ID de la lista de la que se debe cancelar la suscripción al contacto. El identificador que ActiveCampaign les asigna debe hacer referencia a las listas.

    Puede encontrar el ID de lista haciendo clic en la lista en su ActiveCampaign y luego viendo la barra de URL. Se verá algo como esto: /app/contacts/? listid-19&status-1

    También puede recuperar el número de ID de una lista mediante la llamada a la API "Recuperar todas las listas".

Callbacks

El punto de conexión de contacto masivo tiene una función de devolución de llamada para notificar a los usuarios cuando se completa una importación. Incluya la siguiente información en una solicitud de importación de contacto para utilizar esta característica:

JSON
•
“url”: “www.your_web_server.com”,
"contactos": [ ... incluir contactos aquí ... ],
“callback”:
	“requestType”: “ POST”,
	“detailed_results”: “true”,
	“params”: [
		“key”:””,”value”:””-
    ]
	“headers”: [
		“key”:””,”value”:””-
    ]
}
}
  • url   (cadena)
    El punto de conexión de URL al que el importador realizará una solicitud una vez completada la importación.
  • requestType (cadena)
    Se puede establecer en “ GET” o “ POST”. Determina el tipo de solicitud HTTP que se enviará al punto de conexión especificado.
  • detailed_results (cadena)
    Cuando se establece en “true” y el parámetro requestType se establece en “ POST”, la devolución de llamada incluirá el número de éxitos y errores en la solicitud de origen, así como una matriz de mensajes de error para cada contacto con errores.
  • params   (matriz)
    Una lista de parámetros para incluir en la solicitud de devolución de llamada. Agregue cada parámetro en forma de un par clave-valor. Para una solicitud GET, cada parámetro se anexará al final de la dirección URL en una cadena de consulta. Para una solicitud POST, los parámetros se incluirán en el cuerpo de la solicitud. 
  • encabezados (matriz)
    Una lista de encabezados para incluir en la solicitud de devolución de llamada. Agregue cada encabezado en forma de un par clave-valor.

Ejemplos

Recibir una notificación

{
"contactos": [ ... incluir contactos aquí ... ],
“callback”:
	“url”: “www.yourwebsite.com/the/api/to/hit”,
    “requestType”: “ GET”,
	“params”: [
		“key”:”msg”,”value”:”hello”?
    ]
	“headers”: [
		“key”:””,”value”:””-
    ]
}
}

 

Params se anexará a la dirección URL como parámetros de consulta en el caso de un “ GET” Petición. Los encabezados se aplicarán a la solicitud antes de enviarla. Este punto de conexión acepta cualquier valor de cadena para claves y valores para parámetros y encabezados.

Resultado:

OBTENER www.yourwebsite.com/the/api/to/hit?msg=hello

Publicación de un mensaje

{
"contactos": [ ... incluir contactos aquí ... ],
“callback”:
	“requestType”: “ POST”,
	“params”: [
		“key”:”msg”,”value”:”Import completed”-
    ]
	“headers”: [
		“key”:” Autorización”,”valor”:” Bearer 4u1h_t0k3N”
    ]
}
}

 

Resultado:

OBTENGA www.yourwebsite.com/the/api/to/hit

JSON
•
“key”:”msg”,”value”:”Import completed”-
]

 

Importar resultados con mensajes de error

{
"contactos": [ ... incluir contactos aquí ... ],
“callback”:
	“requestType”: “ POST”,
	“detailed_results”: “true”,
	“headers”: [
		“key”:””,”value”:””-
    ]
}
}

 

Cuando el “detailed_results” parámetro se establece en " True", la devolución de llamada incluirá:

  • Un objeto JSON que contiene los parámetros especificados
  • Otros tres campos en la respuesta que pueden ayudar con la supervisión y depuración

Resultado:

OBTENGA www.yourwebsite.com/the/api/to/hit

JSON
•
Éxito:
" Errores":0,
"failure_reasons":[]
}
¿Tiene más preguntas? Enviar una solicitud