Pular para o conteúdo

Mailchimp

Mailchimp

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.

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.

Você vai precisar dos seguintes campos:

CampoObrigatórioDescrição
access_tokenSimToken de acesso OAuth 2.0 gerado após autorizar o SquadOS a acessar sua conta Mailchimp.

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.

  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por Mailchimp.
  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 autoriza o acesso à sua conta Mailchimp via OAuth.
  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.)

MAILCHIMP_ADD_CAMPAIGN

Cria uma nova campanha no Mailchimp. Suporta os tipos regular, texto simples, RSS e variate (A/B multivariado).

NomeTipoObrigatórioDescrição
typestring ("regular" | "plaintext" | "absplit" | "rss" | "variate")SimO tipo da campanha. Campanhas A/B Split foram descontinuadas; use variate.
settings__subject__linestringNãoA linha de assunto da campanha.
settings__titlestringNãoO título interno da campanha.
settings__from__namestringNãoO nome do remetente exibido no campo “De”. Não é um endereço de e-mail.
settings__reply__tostringNãoO endereço de e-mail de resposta. Obrigatório para o envio.
recipients__list__idstringNãoO ID único da audiência/lista de destino.
settings__template__idintegerNãoO ID do template a usar.
content_typestring ("template" | "multichannel")NãoComo o conteúdo da campanha é montado. Padrão: template.
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.

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.

NomeTipoObrigatórioDescrição
namestringSimNome da audiência. Deve ser único na conta.
contact__companystringSimNome da empresa para o contato da lista.
contact__address1stringSimEndereço do contato da lista.
contact__citystringSimCidade do contato da lista.
contact__countrystringSimCódigo de país ISO 3166 de dois caracteres (ex: 'US', 'BR').
permission_reminderstringSimLembrete de permissão explicando por que os contatos recebem e-mails desta lista.
campaign__defaults__from__namestringSimNome do remetente padrão para campanhas enviadas a esta lista.
campaign__defaults__from__emailstringSimE-mail do remetente padrão para campanhas desta lista.
campaign__defaults__subjectstringSimAssunto padrão para campanhas desta lista.
campaign__defaults__languagestringSimIdioma padrão dos formulários desta lista (ex: 'en', 'pt').
double_optinbooleanNãoExigir confirmação por e-mail (double opt-in). Recomendado para conformidade com GDPR.
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.

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.

NomeTipoObrigatórioDescrição
list_idstringSimO ID único da lista/audiência.
email_addressstringSimEndereço de e-mail do assinante. Obrigatório se o e-mail ainda não estiver na lista.
subscriber_hashstringSimHash MD5 do e-mail em minúsculas, ou o próprio e-mail, ou o contact_id.
status_if_newstring ("subscribed" | "unsubscribed" | "cleaned" | "pending" | "transactional")SimStatus do assinante ao criar um novo membro.
statusstring ("subscribed" | "unsubscribed" | "cleaned" | "pending" | "transactional")NãoStatus atual do assinante ao atualizar.
merge_fieldsobjectNãoDicionário de campos de merge (ex: FNAME, LNAME).
skip_merge_validationbooleanNãoSe true, aceita dados sem preencher campos de merge obrigatórios. Padrão: false.
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.

MAILCHIMP_BATCH_SUBSCRIBE_OR_UNSUBSCRIBE

Inscreve ou cancela a inscrição de membros da lista em lote. Suporta até 500 membros por chamada.

NomeTipoObrigatórioDescrição
list_idstringSimO ID único da lista.
membersarraySimArray 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_existingbooleanNãoSe true, atualiza membros existentes. Padrão: false.
sync_tagsbooleanNãoSe true, substitui todas as tags existentes pelas tags da requisiçã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.

MAILCHIMP_GET_CAMPAIGN_INFO

Retorna informações sobre uma campanha específica.

NomeTipoObrigatórioDescrição
campaign_idstringSimO ID único da campanha.
fieldsarrayNãoLista de campos a retornar. Use notação de ponto para sub-objetos.
exclude_fieldsarrayNãoLista de campos a excluir da resposta. Não pode ser usado junto com fields.
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.

MAILCHIMP_GET_LIST_INFO

Retorna informações sobre uma lista específica da conta Mailchimp, incluindo membros inscritos, não confirmados e descadastrados.

NomeTipoObrigatórioDescrição
list_idstringSimO ID único da lista.
fieldsarrayNãoLista de campos a retornar separados por vírgula.
exclude_fieldsarrayNãoLista de campos a excluir.
include_total_contactsbooleanNãoRetorna o campo total_contacts com a contagem aproximada de todos os contatos em qualquer estado.
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.

MAILCHIMP_GET_LISTS_INFO

Retorna informações sobre todas as listas/audiências da conta.

NomeTipoObrigatórioDescrição
countintegerNãoNúmero de registros a retornar. Padrão: 10. Máximo: 1000.
offsetintegerNãoNúmero de registros a pular (para paginação). Padrão: 0.
emailstringNãoFiltra listas que contêm o e-mail do assinante informado.
sort_fieldstring ("date_created")NãoCampo para ordenação dos resultados.
sort_dirstring ("ASC" | "DESC")NãoDireção da ordenaçã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.

MAILCHIMP_GET_MEMBER_INFO

Retorna informações sobre um membro específico da lista, incluindo assinantes ativos, descadastrados ou com bounce.

NomeTipoObrigatórioDescrição
list_idstringSimO ID único da lista.
subscriber_hashstringSimHash MD5 do e-mail em minúsculas, o próprio e-mail ou o contact_id.
fieldsstringNãoCampos a retornar. Use nomes de campos de nível superior ou notação de ponto para campos aninhados.
exclude_fieldsstringNãoCampos a excluir.
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.

MAILCHIMP_LIST_MEMBERS_INFO

Retorna informações sobre membros de uma lista Mailchimp específica, com suporte a filtros de status, data e interesses.

NomeTipoObrigatórioDescrição
list_idstringSimO ID único da lista.
countintegerNãoNúmero de registros a retornar. Padrão: 10. Máximo: 1000.
offsetintegerNãoNúmero de registros a pular. Padrão: 0.
statusstring ("subscribed" | "unsubscribed" | "cleaned" | "pending" | "transactional" | "archived")NãoFiltra membros pelo status de assinatura.
sort_fieldstring ("timestamp_opt" | "timestamp_signup" | "last_changed")NãoCampo para ordenação.
sort_dirstring ("ASC" | "DESC")NãoDireção da ordenaçã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.

MAILCHIMP_LIST_CAMPAIGNS

Retorna todas as campanhas da conta, com suporte a filtros por tipo, status, lista e período.

NomeTipoObrigatórioDescrição
countintegerNãoNúmero de registros a retornar. Padrão: 10. Máximo: 1000.
offsetintegerNãoNúmero de registros a pular. Padrão: 0.
typestring ("regular" | "plaintext" | "absplit" | "rss" | "variate")NãoTipo da campanha.
statusstring ("save" | "paused" | "schedule" | "sending" | "sent")NãoStatus da campanha.
list_idstringNãoFiltra campanhas da lista especificada.
sort_fieldstring ("create_time" | "send_time")NãoCampo para ordenação.
sort_dirstring ("ASC" | "DESC")NãoDireção da ordenaçã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.

MAILCHIMP_LIST_SEGMENTS

Retorna informações sobre todos os segmentos disponíveis de uma lista específica.

NomeTipoObrigatórioDescrição
list_idstringSimO ID único da lista.
countintegerNãoNúmero de registros a retornar. Padrão: 10. Máximo: 1000.
offsetintegerNãoNúmero de registros a pular. Padrão: 0.
typestringNãoFiltra por tipo de segmento.
since_created_atstringNãoRestringe a segmentos criados após a data informada (ISO 8601).
before_created_atstringNãoRestringe a segmentos criados antes da data informada (ISO 8601).
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.

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.

NomeTipoObrigatórioDescrição
namestringSimNome do segmento. Deve ser único na lista.
list_idstringSimO ID único da lista onde o segmento será criado.
static_segmentarrayNãoArray de e-mails de membros existentes para um segmento estático. Passe [] para criar um segmento estático vazio.
options__matchstring ("any" | "all")NãoTipo de correspondência para segmentos dinâmicos: any (OR) ou all (AND). Obrigatório ao usar options__conditions.
options__conditionsarrayNãoArray de objetos de condição para segmentos dinâmicos (ex: por e-mail, campo de merge, etc.).
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.

MAILCHIMP_SET_CAMPAIGN_CONTENT

Define o conteúdo de uma campanha. Aceita HTML bruto, texto simples, template ou arquivo compactado.

NomeTipoObrigatórioDescrição
campaign_idstringSimO ID único da campanha.
htmlstringNãoO HTML bruto da campanha.
plain_textstringNãoA versão em texto simples. Se omitida, é gerada automaticamente.
template__idintegerNãoO ID do template a usar.
urlstringNãoURL onde o HTML da campanha está hospedado (para importaçã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.

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.

NomeTipoObrigatórioDescrição
campaign_idstringSimO ID único da campanha a agendar.
schedule_timestringSimData 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.
timewarpbooleanNãoUsa 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__countintegerNãoNúmero de lotes para o Batch Delivery.
batch__delivery__batch__delayintegerNãoIntervalo em minutos entre os lotes do Batch Delivery.
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.

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.

NomeTipoObrigatórioDescrição
campaign_idstringSimO ID único da campanha a enviar. Deve estar no status save e passar todos os requisitos da checklist.
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.

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.

NomeTipoObrigatórioDescrição
campaign_idstringSimO ID único da campanha para envio do teste.
test_emailsarraySimLista de endereços de e-mail para receber o teste (ex: ['usuario@exemplo.com']).
send_typestring ("html" | "plaintext")NãoFormato do e-mail de teste. Padrão: html.
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.

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.

NomeTipoObrigatórioDescrição
list_idstringSimO ID único da lista.
subscriber_hashstringSimHash MD5 do e-mail em minúsculas, o próprio e-mail ou o contact_id.
statusstring ("subscribed" | "unsubscribed" | "cleaned" | "pending")NãoStatus atual do assinante.
merge_fieldsobjectNãoDicionário de campos de merge com os valores atualizados.
languagestringNãoCódigo de idioma do assinante (ex: 'en', 'pt').
vipbooleanNãoStatus VIP do assinante.
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.

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.

NomeTipoObrigatórioDescrição
list_idstringSimO ID único da lista.
subscriber_hashstringSimHash MD5 do e-mail em minúsculas, o próprio e-mail ou o contact_id.
tagsarraySimLista de objetos de tag, cada um com name (string) e status ('active' ou 'inactive').
is_syncingbooleanNãoSe true, automações baseadas nas tags da requisição não serão disparadas. Útil para importações em massa.
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.

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.

NomeTipoObrigatórioDescrição
list_idstringSimO ID único da lista.
subscriber_hashstringSimHash MD5 do e-mail em minúsculas, o próprio e-mail ou o contact_id.
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.

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.

NomeTipoObrigatórioDescrição
querystringSimTermo de busca: e-mail válido ou nome/sobrenome do contato.
list_idstringNãoO ID da lista. Se omitido, a busca é realizada em todas as listas da conta.
fieldsarrayNãoLista de campos a retornar.
exclude_fieldsarrayNãoLista de campos a excluir.
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.

MAILCHIMP_SEARCH_CAMPAIGNS

Busca campanhas por texto nos títulos, assuntos e conteúdos. Retorna informações detalhadas sobre as campanhas encontradas.

NomeTipoObrigatórioDescrição
querystringSimTermo de busca. Pesquisa em títulos de campanha, linhas de assunto e outros conteúdos.
fieldsarrayNãoLista de campos a retornar (use notação de ponto para campos aninhados).
exclude_fieldsarrayNãoLista de campos a excluir da resposta.
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.

MAILCHIMP_REPLICATE_CAMPAIGN

Replica uma campanha com status save ou sent, criando uma cópia em rascunho para reutilização.

NomeTipoObrigatórioDescrição
campaign_idstringSimO ID único da campanha a replicar.
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.

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.

NomeTipoObrigatórioDescrição
namestringSimNome do template. Deve ser único na conta.
htmlstringSimConteúdo HTML do template. Suporta a linguagem de template do Mailchimp. Deve ser HTML válido.
folder_idstringNãoID da pasta onde armazenar o template.
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.

MAILCHIMP_LIST_TEMPLATES

Retorna todos os templates disponíveis na conta, com suporte a filtros por tipo, categoria, pasta e data de criação.

NomeTipoObrigatórioDescrição
countintegerNãoNúmero de registros a retornar. Padrão: 10. Máximo: 1000.
offsetintegerNãoNúmero de registros a pular. Padrão: 0.
typestringNãoFiltra por tipo de template.
categorystringNãoFiltra por categoria.
folder_idstringNãoID da pasta para filtrar templates.
content_typestring ("html" | "template" | "multichannel")NãoFiltra por como o conteúdo do template é montado.
sort_fieldstring ("date_created" | "date_edited" | "name")NãoCampo para ordenação.
sort_dirstring ("ASC" | "DESC")NãoDireção da ordenaçã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.

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.

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.