Pular para o conteúdo

ActiveCampaign

ActiveCampaign

O ActiveCampaign é uma plataforma de automação de marketing e CRM que permite às empresas gerenciar campanhas de e-mail, pipelines de vendas e segmentação de clientes para aumentar o engajamento e impulsionar o crescimento. Com a integração no SquadOS, seus agentes podem criar e atualizar contatos, disparar automações, enviar campanhas e gerenciar negócios no funil de vendas sem sair do fluxo de trabalho.

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

CampoObrigatórioDescrição
api_keySimChave de API gerada no painel do ActiveCampaign em Settings → Developer → API Access.
api_urlSimURL base da sua conta ActiveCampaign, no formato https://<sua-conta>.api-us1.com.
  1. Acesse app.activecampaign.com e faça login na sua conta.
  2. Clique no ícone de perfil no canto inferior esquerdo e acesse Settings (Configurações).
  3. No menu lateral, clique em Developer.
  4. Copie o valor de API URL e o de Key — esses são os dois valores necessários para conectar.
  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por ActiveCampaign.
  3. Clique no card para abrir o modal de detalhes e em Conectar.
  4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa as credenciais obtidas acima.
  5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

ACTIVE_CAMPAIGN_FIND_CONTACT

Encontra um contato específico no ActiveCampaign usando endereço de e-mail, ID ou número de telefone. Esta ação é mais eficiente do que listar todos os contatos quando você precisa localizar um contato específico.

NomeTipoObrigatórioDescrição
idstringNãoO ID do contato no ActiveCampaign.
emailstringNãoO endereço de e-mail do contato.
phonestringNãoO número de telefone do contato. A busca por telefone usa o parâmetro de pesquisa geral internamente e pode retornar correspondências parciais. Quando combinado com e-mail, os resultados são filtrados no lado do cliente para corresponder a ambos os critérios.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_LIST_ALL_CONTACTS

Lista todos os contatos no ActiveCampaign. Suporta paginação, busca por nome/organização/telefone/e-mail, filtro por padrão de e-mail, ordenação por diversos campos e filtragem por lista, tag, segmento ou data de criação/atualização.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero de contatos a retornar por página.
tagidintegerNãoFiltra contatos associados à tag informada.
listidstringNãoFiltra contatos associados à lista informada.
ordersobjectNãoModelo de ordenação dos contatos.
searchstringNãoFiltra contatos buscando em nomes, organização, telefone ou e-mail.
filtersobjectNãoModelo de filtros por data.
id_lessintegerNãoInclui apenas contatos com ID menor que o valor informado.
segmentidintegerNãoRetorna apenas contatos que correspondem a um segmento de lista.
email_likestringNãoFiltra contatos cujo endereço de e-mail contém o valor informado.
id_greaterintegerNãoInclui apenas contatos com ID maior que o valor informado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_CREATE_OR_UPDATE_CONTACT

Cria um novo contato ou atualiza um contato existente no ActiveCampaign usando o endpoint de sincronização. Se já existir um contato com o e-mail informado, ele será atualizado; caso contrário, um novo contato será criado. É a maneira recomendada de manter os dados de contato atualizados sem verificar manualmente a existência.

NomeTipoObrigatórioDescrição
contactobjectSimObjeto de contato contendo o e-mail e outros campos a sincronizar. O e-mail é usado para localizar contatos existentes.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_UPDATE_CONTACT

Atualiza um contato existente no ActiveCampaign pelo ID. Use quando precisar modificar campos específicos de um contato, como e-mail, nome ou telefone. Relacionamentos entre contatos e organizações são gerenciados pelos endpoints de Account-Contact.

NomeTipoObrigatórioDescrição
idintegerSimO ID do contato a atualizar.
emailstringNãoO novo endereço de e-mail do contato.
phonestringNãoO novo número de telefone do contato.
lastNamestringNãoO novo sobrenome do contato.
firstNamestringNãoO novo primeiro nome do contato.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_DELETE_CONTACT

Exclui permanentemente um contato do ActiveCampaign pelo ID. Esta ação é irreversível e remove o contato e todos os dados associados do sistema. A exclusão é imediata e não pode ser desfeita.

NomeTipoObrigatórioDescrição
contact_idintegerSimO ID do contato a excluir. IDs de contato podem ser obtidos em ações de criação, busca ou listagem de contatos.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_ADD_CONTACT_TO_LIST

Adiciona ou remove a inscrição de um contato em uma lista no ActiveCampaign. Use quando precisar inscrever ou cancelar a inscrição de um contato em uma lista específica usando os respectivos IDs.

NomeTipoObrigatórioDescrição
listintegerSimO ID da lista para adicionar o contato.
statusintegerSimO status de inscrição. Use 1 para inscrito, 2 para cancelado.
contactintegerSimO ID do contato a adicionar à lista.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_ADD_CONTACT_TO_AUTOMATION

Adiciona um contato existente do ActiveCampaign a um fluxo de automação específico. O contato deve já existir no ActiveCampaign e a automação deve ter sido criada previamente pela interface do ActiveCampaign (automações não podem ser criadas via API). A ação realiza dois passos: (1) localiza o contato pelo e-mail para obter o ID; (2) inscreve o contato na automação informada.

NomeTipoObrigatórioDescrição
automation_idstringSimID da automação à qual o contato será adicionado.
contact_emailstringSimEndereço de e-mail do contato a adicionar à automação.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_ADD_CONTACT_NOTE

Adiciona uma nota a um contato no ActiveCampaign. A nota será associada ao contato como tipo assinante. A ação primeiro localiza o ID do contato pelo endereço de e-mail e depois cria a nota.

NomeTipoObrigatórioDescrição
notestringSimO conteúdo da nota a adicionar. Deve ser texto simples — HTML será removido.
contact_emailstringSimO endereço de e-mail do contato ao qual a nota será associada.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_ADD_TAG_TO_CONTACT

Associa uma tag a um contato no ActiveCampaign. Use quando precisar vincular diretamente uma tag a um contato usando os respectivos IDs. Tanto o ID do contato quanto o ID da tag devem existir previamente.

NomeTipoObrigatórioDescrição
tagstringSimID da tag a adicionar ao contato.
contactstringSimID do contato ao qual a tag será adicionada.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_REMOVE_TAG_FROM_CONTACT

Remove uma tag de um contato no ActiveCampaign. Requer o ID do relacionamento contactTag (o ID da associação entre contato e tag, não o ID da tag em si).

NomeTipoObrigatórioDescrição
tag_idstringSimO ID do relacionamento contactTag a remover. Este é o ID da associação entre contato e tag, não o ID da tag. Pode ser obtido pelas ações ACTIVE_CAMPAIGN_GET_CONTACT_TAGS ou ACTIVE_CAMPAIGN_ADD_TAG_TO_CONTACT.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_MANAGE_CONTACT_TAG

Gerencia tags de um contato no ActiveCampaign, permitindo adicionar ou remover tags. A ação pode ser realizada usando o ID ou o endereço de e-mail do contato.

NomeTipoObrigatórioDescrição
tagsstringSimTags a adicionar/remover. Pode ser uma string separada por vírgulas ou uma lista de strings.
actionstring ("Add" ou "Remove")SimA ação a executar nas tags.
contact_idstringNãoO ID do contato para gerenciar as tags.
contact_emailstringNãoO e-mail do contato (usado se contact_id não for fornecido).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_CREATE_CAMPAIGN

Cria uma nova campanha no ActiveCampaign. Use quando precisar criar uma campanha de e-mail em massa (broadcast) ou uma campanha de automação.

NomeTipoObrigatórioDescrição
namestringSimNome da campanha a criar. Deve ser único.
typestring ("single", "recurring", "split", "responder", "reminder", "special", "activerss", "automation")SimTipo de campanha. "single" para e-mails em massa, "automation" para campanhas automatizadas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_LIST_CAMPAIGNS

Lista todas as campanhas no ActiveCampaign, incluindo campanhas padrão e de automação. Suporta paginação e filtros.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de campanhas a retornar (padrão: 20).
offsetintegerNãoNúmero de campanhas a ignorar para paginação.
ordersobjectNãoModelo de ordenação das campanhas.
filtersobjectNãoModelo de filtros das campanhas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_GET_CAMPAIGN_BY_ID

Recupera uma única campanha pelo ID no ActiveCampaign. Retorna detalhes abrangentes da campanha, incluindo métricas de engajamento, configuração de conteúdo e configurações de automação.

NomeTipoObrigatórioDescrição
idintegerSimO ID da campanha a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_CREATE_MESSAGE

Cria uma mensagem de e-mail no ActiveCampaign. Use quando precisar criar um template de mensagem de e-mail para usar em campanhas ou automações. A mensagem deve incluir assunto, informações do remetente (nome e e-mail), endereço de resposta e conteúdo (HTML e/ou texto).

NomeTipoObrigatórioDescrição
messageobjectSimO objeto de mensagem contendo todas as propriedades da mensagem.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_CREATE_DEAL_PIPELINE

Cria um novo pipeline de negócios no ActiveCampaign. Um pipeline é a representação visual do processo de vendas, organizando e acompanhando negócios por etapas. Ao criar um novo pipeline, ele automaticamente vem com três etapas padrão: “To Contact”, “In Contact” e “Follow Up”.

NomeTipoObrigatórioDescrição
titlestringSimO nome do pipeline.
usersarrayNãoArray de IDs de usuários com permissão para gerenciar o pipeline. Este parâmetro pode causar erros de API em algumas configurações.
allusersintegerNãoDefina como 1 para permitir que todos os usuários gerenciem o pipeline.
currencystringSimA moeda padrão para negócios neste pipeline (código ISO 4217, ex.: "usd", "eur", "brl").
allgroupsintegerNãoDefina como 1 para permitir que todos os grupos de usuários gerenciem o pipeline.
autoassignintegerNãoDefina como 1 para habilitar a atribuição automática de novos negócios a proprietários.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_LIST_DEALS2

Lista todos os negócios do ActiveCampaign com capacidades de busca e filtragem. Use quando precisar recuperar negócios filtrando por etapa, pipeline, proprietário ou status.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero de negócios a retornar por página. O valor máximo típico é 100.
offsetintegerNãoDeslocamento de paginação — número de registros a ignorar antes de retornar resultados.
filters_groupintegerNãoFiltra pelo ID do pipeline (também chamado de group).
filters_ownerintegerNãoFiltra pelo ID do proprietário (ID do usuário).
filters_stageintegerNãoFiltra pelo ID da etapa do negócio.
filters_searchstringNãoBusca negócios por título.
filters_statusintegerNãoFiltra por status do negócio. Use 0 para abertos, 1 para ganhos, 2 para perdidos.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_RETRIEVE_A_DEAL

Recupera um negócio específico pelo ID no ActiveCampaign. Retorna informações detalhadas incluindo título, valor, etapa, status e contatos ou organizações associados.

NomeTipoObrigatórioDescrição
idintegerSimO ID do negócio a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_UPDATE_A_DEAL

Atualiza um negócio existente no ActiveCampaign. Use quando precisar modificar propriedades do negócio como título, valor, etapa ou status.

NomeTipoObrigatórioDescrição
idintegerSimO ID do negócio a atualizar.
groupstringNãoO ID do pipeline (deal group) deste negócio.
ownerstringNãoO ID do usuário proprietário do negócio.
stageintegerNãoO ID da etapa dentro do pipeline.
titlestringNãoO novo título do negócio.
valueintegerNãoO novo valor do negócio em centavos (ex.: R$ 1.850,00 deve ser informado como 185000).
statusintegerNãoO status do negócio. Use 0 para aberto, 1 para ganho, 2 para perdido.
accountstringNãoO ID da conta associada a este negócio.
contactstringNãoO ID do contato principal associado a este negócio.
percentintegerNãoO percentual de conclusão do negócio.
currencystringNãoO código de moeda no formato ISO 3 dígitos em minúsculas (ex.: "usd", "eur", "brl").
descriptionstringNãoUma descrição do negócio.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_DELETE_DEAL

Exclui permanentemente um negócio do ActiveCampaign pelo ID. Esta ação é irreversível e remove o negócio e todos os dados associados. A exclusão é imediata e não pode ser desfeita.

NomeTipoObrigatórioDescrição
idintegerSimO ID do negócio a excluir. IDs de negócios podem ser obtidos em ações de criação, atualização ou listagem de negócios.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_CREATE_LIST

Cria uma nova lista de assinantes no ActiveCampaign. Use quando precisar criar uma lista para organizar contatos e enviar campanhas.

NomeTipoObrigatórioDescrição
listobjectSimObjeto de lista contendo os detalhes da lista a criar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_LIST_AUTOMATIONS

Lista todas as automações no ActiveCampaign. Use para recuperar todos os fluxos de automação da conta. Suporta paginação via limit e offset para lidar com grandes quantidades de automações.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero de automações a retornar por página.
offsetintegerNãoDeslocamento de paginação para recuperar resultados adicionais.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_CREATE_A_TAG2

Cria uma nova tag no ActiveCampaign com especificação explícita do tipo de tag. Use quando precisar criar uma tag do tipo contact (aplicada a contatos) ou template (relacionada a templates).

NomeTipoObrigatórioDescrição
tagstringSimO nome da tag a criar.
tag_typestring ("contact" ou "template")SimO tipo de tag a criar. Use "contact" para tags aplicadas a contatos ou "template" para tags relacionadas a templates.
descriptionstringNãoDescrição opcional para a tag, fornecendo contexto sobre seu propósito.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_LIST_ALL_TAGS2

Recupera todas as tags no ActiveCampaign com funcionalidade de busca. Use quando precisar listar ou pesquisar tags existentes.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero de tags a retornar por requisição (padrão: 20).
offsetintegerNãoNúmero de itens a ignorar para paginação.
searchstringNãoBusca por nome de tag para filtrar resultados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

ACTIVE_CAMPAIGN_CREATE_WEBHOOK

Cria um novo webhook no ActiveCampaign para receber notificações em tempo real quando eventos específicos ocorrem. Use quando precisar configurar notificações automatizadas para atividades de contatos, como inscrições, interações com e-mail ou outros eventos.

NomeTipoObrigatórioDescrição
urlstringSimA URL de destino onde os dados do webhook serão enviados via POST. Deve ser uma URL HTTP/HTTPS válida.
namestringSimO nome do webhook para identificá-lo.
eventsarraySimArray de tipos de evento que acionarão o webhook. Eventos comuns: "subscribe", "unsubscribe", "sent", "open", "click", "bounce", "reply". Use a ação List Webhook Events para ver todos os eventos disponíveis.
listidstringNãoO ID da lista a associar ao webhook. Se fornecido, o webhook só será acionado para eventos dessa lista específica.
sourcesarraySimArray de fontes que podem acionar o webhook. Fontes comuns: "public", "system", "admin", "api".
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.