ActiveCampaign
Visão geral
Seção intitulada “Visão geral”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.
- Site oficial: https://www.activecampaign.com/
- Documentação na Composio: docs.composio.dev/toolkits/active_campaign
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza chave de API (API_KEY) para conectar.
Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Chave de API gerada no painel do ActiveCampaign em Settings → Developer → API Access. |
api_url | Sim | URL base da sua conta ActiveCampaign, no formato https://<sua-conta>.api-us1.com. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Acesse app.activecampaign.com e faça login na sua conta.
- Clique no ícone de perfil no canto inferior esquerdo e acesse Settings (Configurações).
- No menu lateral, clique em Developer.
- Copie o valor de API URL e o de Key — esses são os dois valores necessários para conectar.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
ActiveCampaign. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde informa as credenciais obtidas acima.
- 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.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Buscar contato
Seção intitulada “Buscar contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Não | O ID do contato no ActiveCampaign. |
email | string | Não | O endereço de e-mail do contato. |
phone | string | Não | O 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. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os contatos
Seção intitulada “Listar todos os contatos”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | Não | Número de contatos a retornar por página. |
tagid | integer | Não | Filtra contatos associados à tag informada. |
listid | string | Não | Filtra contatos associados à lista informada. |
orders | object | Não | Modelo de ordenação dos contatos. |
search | string | Não | Filtra contatos buscando em nomes, organização, telefone ou e-mail. |
filters | object | Não | Modelo de filtros por data. |
id_less | integer | Não | Inclui apenas contatos com ID menor que o valor informado. |
segmentid | integer | Não | Retorna apenas contatos que correspondem a um segmento de lista. |
email_like | string | Não | Filtra contatos cujo endereço de e-mail contém o valor informado. |
id_greater | integer | Não | Inclui apenas contatos com ID maior que o valor informado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar ou atualizar contato
Seção intitulada “Criar ou atualizar contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact | object | Sim | Objeto de contato contendo o e-mail e outros campos a sincronizar. O e-mail é usado para localizar contatos existentes. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar contato
Seção intitulada “Atualizar contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | O ID do contato a atualizar. |
email | string | Não | O novo endereço de e-mail do contato. |
phone | string | Não | O novo número de telefone do contato. |
lastName | string | Não | O novo sobrenome do contato. |
firstName | string | Não | O novo primeiro nome do contato. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir contato
Seção intitulada “Excluir contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
contact_id | integer | Sim | O ID do contato a excluir. IDs de contato podem ser obtidos em ações de criação, busca ou listagem de contatos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar contato a uma lista
Seção intitulada “Adicionar contato a uma lista”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list | integer | Sim | O ID da lista para adicionar o contato. |
status | integer | Sim | O status de inscrição. Use 1 para inscrito, 2 para cancelado. |
contact | integer | Sim | O ID do contato a adicionar à lista. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar contato a uma automação
Seção intitulada “Adicionar contato a uma automação”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
automation_id | string | Sim | ID da automação à qual o contato será adicionado. |
contact_email | string | Sim | Endereço de e-mail do contato a adicionar à automação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar nota ao contato
Seção intitulada “Adicionar nota ao contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
note | string | Sim | O conteúdo da nota a adicionar. Deve ser texto simples — HTML será removido. |
contact_email | string | Sim | O endereço de e-mail do contato ao qual a nota será associada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar tag ao contato
Seção intitulada “Adicionar tag ao contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tag | string | Sim | ID da tag a adicionar ao contato. |
contact | string | Sim | ID do contato ao qual a tag será adicionada. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Remover tag do contato
Seção intitulada “Remover tag do contato”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).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tag_id | string | Sim | O 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. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Gerenciar tags do contato
Seção intitulada “Gerenciar tags do contato”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tags | string | Sim | Tags a adicionar/remover. Pode ser uma string separada por vírgulas ou uma lista de strings. |
action | string ("Add" ou "Remove") | Sim | A ação a executar nas tags. |
contact_id | string | Não | O ID do contato para gerenciar as tags. |
contact_email | string | Não | O e-mail do contato (usado se contact_id não for fornecido). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar campanha
Seção intitulada “Criar campanha”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da campanha a criar. Deve ser único. |
type | string ("single", "recurring", "split", "responder", "reminder", "special", "activerss", "automation") | Sim | Tipo de campanha. "single" para e-mails em massa, "automation" para campanhas automatizadas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar campanhas
Seção intitulada “Listar campanhas”ACTIVE_CAMPAIGN_LIST_CAMPAIGNS
Lista todas as campanhas no ActiveCampaign, incluindo campanhas padrão e de automação. Suporta paginação e filtros.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | Não | Número máximo de campanhas a retornar (padrão: 20). |
offset | integer | Não | Número de campanhas a ignorar para paginação. |
orders | object | Não | Modelo de ordenação das campanhas. |
filters | object | Não | Modelo de filtros das campanhas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter campanha pelo ID
Seção intitulada “Obter campanha pelo ID”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | O ID da campanha a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar mensagem
Seção intitulada “Criar mensagem”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).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
message | object | Sim | O objeto de mensagem contendo todas as propriedades da mensagem. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar pipeline de negócios
Seção intitulada “Criar pipeline de negócios”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”.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
title | string | Sim | O nome do pipeline. |
users | array | Não | Array de IDs de usuários com permissão para gerenciar o pipeline. Este parâmetro pode causar erros de API em algumas configurações. |
allusers | integer | Não | Defina como 1 para permitir que todos os usuários gerenciem o pipeline. |
currency | string | Sim | A moeda padrão para negócios neste pipeline (código ISO 4217, ex.: "usd", "eur", "brl"). |
allgroups | integer | Não | Defina como 1 para permitir que todos os grupos de usuários gerenciem o pipeline. |
autoassign | integer | Não | Defina como 1 para habilitar a atribuição automática de novos negócios a proprietários. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todos os negócios (busca e filtro)
Seção intitulada “Listar todos os negócios (busca e filtro)”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | Não | Número de negócios a retornar por página. O valor máximo típico é 100. |
offset | integer | Não | Deslocamento de paginação — número de registros a ignorar antes de retornar resultados. |
filters_group | integer | Não | Filtra pelo ID do pipeline (também chamado de group). |
filters_owner | integer | Não | Filtra pelo ID do proprietário (ID do usuário). |
filters_stage | integer | Não | Filtra pelo ID da etapa do negócio. |
filters_search | string | Não | Busca negócios por título. |
filters_status | integer | Não | Filtra por status do negócio. Use 0 para abertos, 1 para ganhos, 2 para perdidos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Recuperar um negócio
Seção intitulada “Recuperar um negócio”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | O ID do negócio a recuperar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar um negócio
Seção intitulada “Atualizar um negócio”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | O ID do negócio a atualizar. |
group | string | Não | O ID do pipeline (deal group) deste negócio. |
owner | string | Não | O ID do usuário proprietário do negócio. |
stage | integer | Não | O ID da etapa dentro do pipeline. |
title | string | Não | O novo título do negócio. |
value | integer | Não | O novo valor do negócio em centavos (ex.: R$ 1.850,00 deve ser informado como 185000). |
status | integer | Não | O status do negócio. Use 0 para aberto, 1 para ganho, 2 para perdido. |
account | string | Não | O ID da conta associada a este negócio. |
contact | string | Não | O ID do contato principal associado a este negócio. |
percent | integer | Não | O percentual de conclusão do negócio. |
currency | string | Não | O código de moeda no formato ISO 3 dígitos em minúsculas (ex.: "usd", "eur", "brl"). |
description | string | Não | Uma descrição do negócio. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir negócio
Seção intitulada “Excluir negócio”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | integer | Sim | O 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. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar lista
Seção intitulada “Criar lista”ACTIVE_CAMPAIGN_CREATE_LIST
Cria uma nova lista de assinantes no ActiveCampaign. Use quando precisar criar uma lista para organizar contatos e enviar campanhas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list | object | Sim | Objeto de lista contendo os detalhes da lista a criar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar automações
Seção intitulada “Listar automações”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | Não | Número de automações a retornar por página. |
offset | integer | Não | Deslocamento de paginação para recuperar resultados adicionais. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar tag com tipo
Seção intitulada “Criar tag com tipo”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).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tag | string | Sim | O nome da tag a criar. |
tag_type | string ("contact" ou "template") | Sim | O tipo de tag a criar. Use "contact" para tags aplicadas a contatos ou "template" para tags relacionadas a templates. |
description | string | Não | Descrição opcional para a tag, fornecendo contexto sobre seu propósito. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar todas as tags
Seção intitulada “Listar todas as tags”ACTIVE_CAMPAIGN_LIST_ALL_TAGS2
Recupera todas as tags no ActiveCampaign com funcionalidade de busca. Use quando precisar listar ou pesquisar tags existentes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
limit | integer | Não | Número de tags a retornar por requisição (padrão: 20). |
offset | integer | Não | Número de itens a ignorar para paginação. |
search | string | Não | Busca por nome de tag para filtrar resultados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar webhook
Seção intitulada “Criar webhook”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.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
url | string | Sim | A URL de destino onde os dados do webhook serão enviados via POST. Deve ser uma URL HTTP/HTTPS válida. |
name | string | Sim | O nome do webhook para identificá-lo. |
events | array | Sim | Array 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. |
listid | string | Não | O ID da lista a associar ao webhook. Se fornecido, o webhook só será acionado para eventos dessa lista específica. |
sources | array | Sim | Array de fontes que podem acionar o webhook. Fontes comuns: "public", "system", "admin", "api". |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |