Com a ActiveCampaign, você pode usar a API do Importador de Contato em Massa para carregar um grande número de contatos em sua conta com apenas uma chamada de API.
Tome nota
- A API do Importador de Contato em Massa está disponível em todos os planos ActiveCampaign
- Este recurso é para usuários avançados que estão familiarizados com a API e são confortáveis em usá-lo para importar contatos
Sobre a API importador de contato a granel
O importador de contato a granel foi projetado para realizar operações em grandes quantidades de contatos ao mesmo tempo. Essas operações incluem:
- Criando novos contatos
- Atualização de contatos existentes
- Definindo campos em contatos
- Contatos de marcação
- Adição de contatos a listas
Observação
O Importador de Contato em Massa não foi projetado para suportar operações frequentes envolvendo um pequeno número de contatos ou para sincronizar atualizações em tempo real a partir de um banco de dados externo. Em vez disso, as atualizações de contato devem ser coletadas em lotes maiores e importadas em grupo. Os contatos podem ser importados em lotes de até 250 itens.
Se você precisar carregar 10 ou menos contatos por vez, use a funcionalidade Contatos da nossa API ActiveCampaign V3.
Limitação de taxas
O processo de importador a granel é otimizado para o upload de listas maiores de contatos. Executar solicitações frequentes que envolvem um pequeno número de contatos requer sobrecarga significativa, e pode afetar o ’ desempenho do importador. Como resultado, aplicamos os seguintes limites de taxa na API do Importador de Contato em Massa:
- Para solicitações que contenham um único contato, há um limite de 20 solicitações por minuto
- Para solicitações contendo vários contatos, há um limite de 100 solicitações por minuto
Recomendamos que todos os usuários tentem fazer atualizações em grupos o maior possível antes de iniciar uma importação.
Limitação do tamanho da carga
O tamanho da carga útil de uma única solicitação de bulk_import deve ser inferior a 400000 bytes.
Contatos ignorados
Os contatos devem atender a todos os seguintes critérios para serem criados ou atualizados com esta API:
- Os contatos importados não podem exceder o limite da sua conta
- O contato deve ter um endereço de email
- O ’ endereço de email do contato não deve estar em uma lista de exclusão
- O ’ email do contato não deve estar em uma lista de endereços de email recuperados
- O contato não deve ter desubscrevido a uma lista que a importação os adicionaria a
Se os contatos não atenderem a todos esses requisitos, eles serão ignorados pelo importador.
Documentação da API
POST https://youraccountname.api-us1.com/api/3/import/bulk_import
Estrutura de solicitação
JSON
{
"contatos": [{"email": "someone@somewhere.com","first_name": "Jane","last_name": "Doe","phone": "123-456-7890","customer_acct_name": "ActiveCampaign","tags": ["dictumst aliquam augue quam sollicitudin rutrum",],"fields": [
{
"id": 1,
"value": "foo"},
{"id": 2,"valor": "foo|| bar|| baz"}
],
"subscribe": [{"listid": 1}, {"listid": 2}],"unsubscribe": [{"listid": 3}],}],"callback":
}
Response
200 OK
{
"Success":1,"queued_contacts":1,"batchId":"0641fbdd-f62f-4c2c-ba02-3a83d5d11ac9",
"message":"Contact import queued"
}
400 Bad Request
{
"Success":0,
"message":"JSON payload não passou na validação. Por favor, corrigir falhasReasons e tentar novamente. A importação não foi enfileirada para processamento.",
"failureReasons":["Payload must contain a 'contacts' field"]
}
Params corporais
matriz contacts* (objeto)
Uma série de objetos contendo informações sobre um único contato. Até 250 contatos podem ser incluídos em uma única solicitação. Cada contato pode conter os seguintes campos:
-
email* (string)
O email do contato. -
first_name (cadeia de caracteres)
O primeiro nome do contato. -
last_name (cadeia de caracteres)
O sobrenome do contato. -
telefone (string)
O número de telefone do contato. -
customer_acct_name (cadeia de caracteres)
O nome da conta do contato. -
matriz de tags (string)
Cada string na matriz será adicionada como uma única tag ao contato. Novas tags serão criadas se elas ainda não existirem. -
matriz de campos (objeto)
Uma lista de campos personalizados a serem aplicados ao contato. Cada campo deve conter dois campos: Cada contato pode ter até N campos personalizados. -
id* (número)
O ID do campo personalizado. Os campos personalizados devem ser referenciados pelo ID que a ActiveCampaign atribui a eles. Você pode recuperar o número de ID de um campo personalizado usando a chamada de API "Listar todos os campos personalizados". -
value* (string)
O valor do campo personalizado. Vários valores podem ser preenchidos para campos de vários valores, separando os diferentes valores pelo delimitador de canos duplos ( " || " ). -
matriz de inscrição (objeto)
Uma matriz de listas para inscrever o contato. Os contatos não podem ser subscritos em listas das quais eles não foram subscritos anteriormente. Cada objeto de lista contém um único campo. -
listid* (número)
O ID da lista para inscrever o contato. As listas devem ser referenciadas pelo ID que a ActiveCampaign atribui a elas.
Você pode encontrar o ID da lista clicando na lista em sua conta da ActiveCampaign e visualizando a barra de URL. Será algo parecido com isto: /app/contacts/?listid=19&status=1
Você também pode recuperar o número de ID de uma lista usando a chamada de API "Recuperar todas as listas". -
matriz de cancelamento de inscrição (objeto)
Uma matriz de listas para cancelar a inscrição do contato. Cada objeto de lista contém um único campo.
listid* (número)O ID da lista da qual cancelar a inscrição do contato. As listas devem ser referenciadas pelo ID que a ActiveCampaign atribui a elas.
Você pode encontrar o ID da lista clicando na lista no ActiveCampaign e visualizando a barra de URL. Será algo parecido com isto: /app/contacts/?listid=19&status=1
Você também pode recuperar o número de ID de uma lista usando a chamada de API "Recuperar todas as listas".
Retornos
O ponto final de contato em massa tem uma função de retorno de chamada para notificar os usuários quando uma importação estiver concluída. Inclua as seguintes informações em uma solicitação de importação de contato para usar este recurso:
JSON
{
"contatos": [ ... incluir contatos aqui ... ],"callback": {"URL": "www.your_web_server.com","requestType": "POST","detailed_results": "true","params": [{"key":"","value":""}]"headers": [
{"key":"",
"value":""}]
}}
-
URL (string)
O ponto de extremidade de URL para o qual o importador fará uma solicitação depois que a importação for concluída. -
requestType (string)
Pode ser definido como "GET" ou "POST". Determina o tipo de solicitação HTTP que será enviada para o ponto final especificado. -
detailed_results (string)
Quando definido como "true" e o parâmetro requestType é definido como "POST", o retorno de chamada incluirá o número de sucessos e falhas na solicitação de origem, bem como uma matriz de mensagens de erro para cada contato com falha. -
params (matriz)
Uma lista de parâmetros a serem incluídos na solicitação de retorno de chamada. Adicione cada parâmetro na forma de um par de valor-chave. Para uma solicitação GET, cada parâmetro será anexado ao final da URL em uma sequência de consulta. Para uma solicitação POST, os parâmetros serão incluídos no corpo da solicitação. - cabeçalhos (matriz)
- Uma lista de cabeçalhos para incluir na solicitação de retorno de chamada. Adicione cada cabeçalho na forma de um par de valor-chave.
Exemplos
Receber uma notificação
{
"contatos": [ ... incluir contatos aqui ... ],"callback": {"URL": "www.yourwebsite.com/the/api/to/hit","requestType": "GET","params": [{"key":"msg","value":"hello"}]"headers": [
{"key":"",
"value":""}]
}}
Os params serão anexados à URL como parâmetros de consulta no caso de uma "" solicitação GET. Os cabeçalhos serão aplicados à solicitação antes de serem enviados. Este ponto final aceita qualquer valor de sequência para chaves e valores para param e cabeçalhos.
Resultado:
COMEÇAR www.yourwebsite.com/the/api/to/hit?msg=hello
Postando uma mensagem
{
"contatos": [ ... incluir contatos aqui ... ],"callback": {"requestType": "POST","params": [{"key":"msg","value":"Import completed"}]"headers": [
{"key":"Authorization",
"value":"Bearer 4u1h_t0k3N"}]
}}
Resultado:
COMEÇAR www.yourwebsite.com/the/api/to/hit
JSON
[
{"key":"msg","value":"Importação concluída"}
]
Resultados de importação com mensagens de erro
{
"contatos": [ ... incluir contatos aqui ... ],"callback": {"requestType": "POST","detailed_results": "true","headers": [{"key":"",
"value":""}]
}}
Quando o " parâmetro detailed_results for definido como " "True", o retorno de chamada incluirá:
- Um objeto JSON contendo os params especificados
- Três outros campos na resposta que podem ajudar no monitoramento e depuração
Resultado:
COMEÇAR www.yourwebsite.com/the/api/to/hit
JSON
{
"Sucesso":1,"Fracassos":0,
"failure_reasons":[]
}