Mailchimp
Visão geral
Seção intitulada “Visão geral”Mailchimp é uma plataforma de e-mail marketing e automação que oferece templates de campanha, segmentação de audiência e análises de desempenho para impulsionar o engajamento e as conversões. Com a integração Mailchimp no SquadOS, seus agentes podem criar e enviar campanhas, gerenciar contatos, adicionar ou remover tags, criar segmentos e muito mais — tudo de forma programática e sem intervenção manual.
- Site oficial: https://mailchimp.com/
- Documentação na Composio: docs.composio.dev/toolkits/mailchimp
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.
Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
access_token | Sim | Token de acesso OAuth 2.0 gerado após autorizar o SquadOS a acessar sua conta Mailchimp. |
Como obter a credencial
Seção intitulada “Como obter a credencial”A autenticação do Mailchimp via Composio usa o fluxo OAuth 2.0 gerenciado — você não precisa criar credenciais manualmente. Ao clicar em Conectar, você é redirecionado para a página de autorização do Mailchimp, onde faz login e concede acesso. O token é gerado e armazenado automaticamente pela Composio.
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
Mailchimp. - 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 autoriza o acesso à sua conta Mailchimp via OAuth.
- 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”Criar campanha
Seção intitulada “Criar campanha”MAILCHIMP_ADD_CAMPAIGN
Cria uma nova campanha no Mailchimp. Suporta os tipos regular, texto simples, RSS e variate (A/B multivariado).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
type | string ("regular" | "plaintext" | "absplit" | "rss" | "variate") | Sim | O tipo da campanha. Campanhas A/B Split foram descontinuadas; use variate. |
settings__subject__line | string | Não | A linha de assunto da campanha. |
settings__title | string | Não | O título interno da campanha. |
settings__from__name | string | Não | O nome do remetente exibido no campo “De”. Não é um endereço de e-mail. |
settings__reply__to | string | Não | O endereço de e-mail de resposta. Obrigatório para o envio. |
recipients__list__id | string | Não | O ID único da audiência/lista de destino. |
settings__template__id | integer | Não | O ID do template a usar. |
content_type | string ("template" | "multichannel") | Não | Como o conteúdo da campanha é montado. Padrão: template. |
| 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 audiência
Seção intitulada “Criar audiência”MAILCHIMP_ADD_LIST
Cria uma nova audiência (lista) na conta Mailchimp. Contas gratuitas têm limite de 1 audiência; planos pagos permitem múltiplas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da audiência. Deve ser único na conta. |
contact__company | string | Sim | Nome da empresa para o contato da lista. |
contact__address1 | string | Sim | Endereço do contato da lista. |
contact__city | string | Sim | Cidade do contato da lista. |
contact__country | string | Sim | Código de país ISO 3166 de dois caracteres (ex: 'US', 'BR'). |
permission_reminder | string | Sim | Lembrete de permissão explicando por que os contatos recebem e-mails desta lista. |
campaign__defaults__from__name | string | Sim | Nome do remetente padrão para campanhas enviadas a esta lista. |
campaign__defaults__from__email | string | Sim | E-mail do remetente padrão para campanhas desta lista. |
campaign__defaults__subject | string | Sim | Assunto padrão para campanhas desta lista. |
campaign__defaults__language | string | Sim | Idioma padrão dos formulários desta lista (ex: 'en', 'pt'). |
double_optin | boolean | Não | Exigir confirmação por e-mail (double opt-in). Recomendado para conformidade com GDPR. |
| 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 ou atualizar membro da lista
Seção intitulada “Adicionar ou atualizar membro da lista”MAILCHIMP_ADD_OR_UPDATE_LIST_MEMBER
Adiciona ou atualiza um membro (assinante) em uma audiência Mailchimp. Operação de upsert: se o assinante já existe, é atualizado; caso contrário, é criado. O parâmetro subscriber_hash deve ser o hash MD5 do e-mail em minúsculas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | O ID único da lista/audiência. |
email_address | string | Sim | Endereço de e-mail do assinante. Obrigatório se o e-mail ainda não estiver na lista. |
subscriber_hash | string | Sim | Hash MD5 do e-mail em minúsculas, ou o próprio e-mail, ou o contact_id. |
status_if_new | string ("subscribed" | "unsubscribed" | "cleaned" | "pending" | "transactional") | Sim | Status do assinante ao criar um novo membro. |
status | string ("subscribed" | "unsubscribed" | "cleaned" | "pending" | "transactional") | Não | Status atual do assinante ao atualizar. |
merge_fields | object | Não | Dicionário de campos de merge (ex: FNAME, LNAME). |
skip_merge_validation | boolean | Não | Se true, aceita dados sem preencher campos de merge obrigatórios. Padrão: false. |
| 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. |
Inscrever ou cancelar inscrição em lote
Seção intitulada “Inscrever ou cancelar inscrição em lote”MAILCHIMP_BATCH_SUBSCRIBE_OR_UNSUBSCRIBE
Inscreve ou cancela a inscrição de membros da lista em lote. Suporta até 500 membros por chamada.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | O ID único da lista. |
members | array | Sim | Array de objetos de membro. Cada objeto deve conter email_address (string) e status (um de: subscribed, unsubscribed, cleaned, pending, transactional). Suporta até 500 membros por chamada. |
update_existing | boolean | Não | Se true, atualiza membros existentes. Padrão: false. |
sync_tags | boolean | Não | Se true, substitui todas as tags existentes pelas tags da requisiçã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. |
Obter informações de campanha
Seção intitulada “Obter informações de campanha”MAILCHIMP_GET_CAMPAIGN_INFO
Retorna informações sobre uma campanha específica.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
campaign_id | string | Sim | O ID único da campanha. |
fields | array | Não | Lista de campos a retornar. Use notação de ponto para sub-objetos. |
exclude_fields | array | Não | Lista de campos a excluir da resposta. Não pode ser usado junto com fields. |
| 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 informações de uma lista
Seção intitulada “Obter informações de uma lista”MAILCHIMP_GET_LIST_INFO
Retorna informações sobre uma lista específica da conta Mailchimp, incluindo membros inscritos, não confirmados e descadastrados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | O ID único da lista. |
fields | array | Não | Lista de campos a retornar separados por vírgula. |
exclude_fields | array | Não | Lista de campos a excluir. |
include_total_contacts | boolean | Não | Retorna o campo total_contacts com a contagem aproximada de todos os contatos em qualquer estado. |
| 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 audiências
Seção intitulada “Listar todas as audiências”MAILCHIMP_GET_LISTS_INFO
Retorna informações sobre todas as listas/audiências da conta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
count | integer | Não | Número de registros a retornar. Padrão: 10. Máximo: 1000. |
offset | integer | Não | Número de registros a pular (para paginação). Padrão: 0. |
email | string | Não | Filtra listas que contêm o e-mail do assinante informado. |
sort_field | string ("date_created") | Não | Campo para ordenação dos resultados. |
sort_dir | string ("ASC" | "DESC") | Não | Direção da ordenaçã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. |
Obter informações de um membro
Seção intitulada “Obter informações de um membro”MAILCHIMP_GET_MEMBER_INFO
Retorna informações sobre um membro específico da lista, incluindo assinantes ativos, descadastrados ou com bounce.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | O ID único da lista. |
subscriber_hash | string | Sim | Hash MD5 do e-mail em minúsculas, o próprio e-mail ou o contact_id. |
fields | string | Não | Campos a retornar. Use nomes de campos de nível superior ou notação de ponto para campos aninhados. |
exclude_fields | string | Não | Campos a excluir. |
| 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 membros de uma lista
Seção intitulada “Listar membros de uma lista”MAILCHIMP_LIST_MEMBERS_INFO
Retorna informações sobre membros de uma lista Mailchimp específica, com suporte a filtros de status, data e interesses.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | O ID único da lista. |
count | integer | Não | Número de registros a retornar. Padrão: 10. Máximo: 1000. |
offset | integer | Não | Número de registros a pular. Padrão: 0. |
status | string ("subscribed" | "unsubscribed" | "cleaned" | "pending" | "transactional" | "archived") | Não | Filtra membros pelo status de assinatura. |
sort_field | string ("timestamp_opt" | "timestamp_signup" | "last_changed") | Não | Campo para ordenação. |
sort_dir | string ("ASC" | "DESC") | Não | Direção da ordenaçã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. |
Listar campanhas
Seção intitulada “Listar campanhas”MAILCHIMP_LIST_CAMPAIGNS
Retorna todas as campanhas da conta, com suporte a filtros por tipo, status, lista e período.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
count | integer | Não | Número de registros a retornar. Padrão: 10. Máximo: 1000. |
offset | integer | Não | Número de registros a pular. Padrão: 0. |
type | string ("regular" | "plaintext" | "absplit" | "rss" | "variate") | Não | Tipo da campanha. |
status | string ("save" | "paused" | "schedule" | "sending" | "sent") | Não | Status da campanha. |
list_id | string | Não | Filtra campanhas da lista especificada. |
sort_field | string ("create_time" | "send_time") | Não | Campo para ordenação. |
sort_dir | string ("ASC" | "DESC") | Não | Direção da ordenaçã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. |
Listar segmentos
Seção intitulada “Listar segmentos”MAILCHIMP_LIST_SEGMENTS
Retorna informações sobre todos os segmentos disponíveis de uma lista específica.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | O ID único da lista. |
count | integer | Não | Número de registros a retornar. Padrão: 10. Máximo: 1000. |
offset | integer | Não | Número de registros a pular. Padrão: 0. |
type | string | Não | Filtra por tipo de segmento. |
since_created_at | string | Não | Restringe a segmentos criados após a data informada (ISO 8601). |
before_created_at | string | Não | Restringe a segmentos criados antes da data informada (ISO 8601). |
| 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 segmento
Seção intitulada “Criar segmento”MAILCHIMP_ADD_SEGMENT
Cria um novo segmento em uma audiência Mailchimp. Suporta segmentos estáticos (lista de e-mails) ou dinâmicos (baseados em condições). Os campos static_segment e options são mutuamente exclusivos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do segmento. Deve ser único na lista. |
list_id | string | Sim | O ID único da lista onde o segmento será criado. |
static_segment | array | Não | Array de e-mails de membros existentes para um segmento estático. Passe [] para criar um segmento estático vazio. |
options__match | string ("any" | "all") | Não | Tipo de correspondência para segmentos dinâmicos: any (OR) ou all (AND). Obrigatório ao usar options__conditions. |
options__conditions | array | Não | Array de objetos de condição para segmentos dinâmicos (ex: por e-mail, campo de merge, etc.). |
| 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. |
Definir conteúdo da campanha
Seção intitulada “Definir conteúdo da campanha”MAILCHIMP_SET_CAMPAIGN_CONTENT
Define o conteúdo de uma campanha. Aceita HTML bruto, texto simples, template ou arquivo compactado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
campaign_id | string | Sim | O ID único da campanha. |
html | string | Não | O HTML bruto da campanha. |
plain_text | string | Não | A versão em texto simples. Se omitida, é gerada automaticamente. |
template__id | integer | Não | O ID do template a usar. |
url | string | Não | URL onde o HTML da campanha está hospedado (para importaçã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. |
Agendar campanha
Seção intitulada “Agendar campanha”MAILCHIMP_SCHEDULE_CAMPAIGN
Agenda uma campanha para envio em uma data e hora específicas. A campanha deve estar no status save (rascunho) e passar todos os itens da checklist de envio. O horário deve ser futuro e nos incrementos de 15 minutos (:00, :15, :30, :45). Requer plano pago.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
campaign_id | string | Sim | O ID único da campanha a agendar. |
schedule_time | string | Sim | Data e hora UTC para agendamento em formato ISO 8601 (ex: '2026-01-26T12:00:00+00:00'). Deve ser pelo menos 15 minutos no futuro. |
timewarp | boolean | Não | Usa o Timewarp para enviar com base no fuso horário local de cada destinatário. Não pode ser usado com Batch Delivery. |
batch__delivery__batch__count | integer | Não | Número de lotes para o Batch Delivery. |
batch__delivery__batch__delay | integer | Não | Intervalo em minutos entre os lotes do Batch Delivery. |
| 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. |
Enviar campanha
Seção intitulada “Enviar campanha”MAILCHIMP_SEND_CAMPAIGN
Envia uma campanha Mailchimp imediatamente. A campanha deve estar no status save (rascunho), ter audiência válida, assunto, nome do remetente, e-mail verificado e conteúdo definido. Retorna HTTP 204 ao concluir.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
campaign_id | string | Sim | O ID único da campanha a enviar. Deve estar no status save e passar todos os requisitos da checklist. |
| 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. |
Enviar e-mail de teste
Seção intitulada “Enviar e-mail de teste”MAILCHIMP_SEND_TEST_EMAIL
Envia um e-mail de teste de uma campanha para endereços especificados, permitindo visualizar o conteúdo e a formatação antes do envio final. Contas gratuitas podem enviar para até 6 endereços; contas pagas, até 20.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
campaign_id | string | Sim | O ID único da campanha para envio do teste. |
test_emails | array | Sim | Lista de endereços de e-mail para receber o teste (ex: ['usuario@exemplo.com']). |
send_type | string ("html" | "plaintext") | Não | Formato do e-mail de teste. Padrão: html. |
| 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 membro da lista
Seção intitulada “Atualizar membro da lista”MAILCHIMP_UPDATE_LIST_MEMBER
Atualiza informações de um membro específico da lista, incluindo status, campos de merge, tags e preferências de idioma.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | O ID único da lista. |
subscriber_hash | string | Sim | Hash MD5 do e-mail em minúsculas, o próprio e-mail ou o contact_id. |
status | string ("subscribed" | "unsubscribed" | "cleaned" | "pending") | Não | Status atual do assinante. |
merge_fields | object | Não | Dicionário de campos de merge com os valores atualizados. |
language | string | Não | Código de idioma do assinante (ex: 'en', 'pt'). |
vip | boolean | Não | Status VIP do assinante. |
| 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 ou remover tags de membro
Seção intitulada “Adicionar ou remover tags de membro”MAILCHIMP_ADD_OR_REMOVE_MEMBER_TAGS
Adiciona ou remove tags de um membro da lista. Use status: 'active' para adicionar e status: 'inactive' para remover. Se a tag não existir e o status for active, ela é criada automaticamente. Retorna HTTP 204 em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | O ID único da lista. |
subscriber_hash | string | Sim | Hash MD5 do e-mail em minúsculas, o próprio e-mail ou o contact_id. |
tags | array | Sim | Lista de objetos de tag, cada um com name (string) e status ('active' ou 'inactive'). |
is_syncing | boolean | Não | Se true, automações baseadas nas tags da requisição não serão disparadas. Útil para importações em massa. |
| 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. |
Arquivar membro da lista
Seção intitulada “Arquivar membro da lista”MAILCHIMP_ARCHIVE_LIST_MEMBER
Arquiva (soft delete) um membro de uma audiência Mailchimp. O membro é removido da lista ativa, mas seus dados são preservados e pode ser reinscrito posteriormente. Para exclusão permanente, use a ação de deleção definitiva. Retorna HTTP 204 em caso de sucesso.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | O ID único da lista. |
subscriber_hash | string | Sim | Hash MD5 do e-mail em minúsculas, o próprio e-mail ou o contact_id. |
| 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. |
Buscar membros
Seção intitulada “Buscar membros”MAILCHIMP_SEARCH_MEMBERS
Busca membros da lista por e-mail, nome ou sobrenome. Pode ser restrito a uma lista específica ou realizado em todas as listas da conta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Sim | Termo de busca: e-mail válido ou nome/sobrenome do contato. |
list_id | string | Não | O ID da lista. Se omitido, a busca é realizada em todas as listas da conta. |
fields | array | Não | Lista de campos a retornar. |
exclude_fields | array | Não | Lista de campos a excluir. |
| 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. |
Buscar campanhas
Seção intitulada “Buscar campanhas”MAILCHIMP_SEARCH_CAMPAIGNS
Busca campanhas por texto nos títulos, assuntos e conteúdos. Retorna informações detalhadas sobre as campanhas encontradas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Sim | Termo de busca. Pesquisa em títulos de campanha, linhas de assunto e outros conteúdos. |
fields | array | Não | Lista de campos a retornar (use notação de ponto para campos aninhados). |
exclude_fields | array | Não | Lista de campos a excluir da resposta. |
| 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. |
Replicar campanha
Seção intitulada “Replicar campanha”MAILCHIMP_REPLICATE_CAMPAIGN
Replica uma campanha com status save ou sent, criando uma cópia em rascunho para reutilização.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
campaign_id | string | Sim | O ID único da campanha a replicar. |
| 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 template
Seção intitulada “Criar template”MAILCHIMP_ADD_TEMPLATE
Cria um novo template de e-mail na conta Mailchimp. Somente templates clássicos (HTML) são suportados via API. O HTML pode incluir merge tags do Mailchimp (ex: *|FNAME|*) para personalização.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do template. Deve ser único na conta. |
html | string | Sim | Conteúdo HTML do template. Suporta a linguagem de template do Mailchimp. Deve ser HTML válido. |
folder_id | string | Não | ID da pasta onde armazenar o template. |
| 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 templates
Seção intitulada “Listar templates”MAILCHIMP_LIST_TEMPLATES
Retorna todos os templates disponíveis na conta, com suporte a filtros por tipo, categoria, pasta e data de criação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
count | integer | Não | Número de registros a retornar. Padrão: 10. Máximo: 1000. |
offset | integer | Não | Número de registros a pular. Padrão: 0. |
type | string | Não | Filtra por tipo de template. |
category | string | Não | Filtra por categoria. |
folder_id | string | Não | ID da pasta para filtrar templates. |
content_type | string ("html" | "template" | "multichannel") | Não | Filtra por como o conteúdo do template é montado. |
sort_field | string ("date_created" | "date_edited" | "name") | Não | Campo para ordenação. |
sort_dir | string ("ASC" | "DESC") | Não | Direção da ordenaçã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. |
Verificar status da API
Seção intitulada “Verificar status da API”MAILCHIMP_PING
Verificação de saúde da API do Mailchimp. Não retorna nenhuma informação específica da conta — útil para confirmar que a conexão está funcionando.
| 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. |