MailChimp
O MailChimp é um serviço SaaS que permite que as empresas gerenciem e automatizem atividades de marketing de email, incluindo o envio de emails de marketing, mensagens automatizadas e campanhas direcionadas.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Microsoft |
| URL |
Suporte do Microsoft LogicApps Suporte do Microsoft Power Automate Suporte do Microsoft Power Apps |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
| Site | https://mailchimp.com/ |
| Política de privacidade | https://mailchimp.com/legal/privacy/ |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar membro à lista |
Adicionar ou atualizar um membro de lista |
| Assinar ou cancelar a assinatura de membros da lista |
Inscrever ou cancelar a assinatura de membros da lista do Lote. |
| Atualizar informações do membro |
Atualize as informações de um membro de lista específico. |
| Enviar campanha (versão prévia) |
Enviar uma campanha existente |
| Listar campanhas |
Esta operação recupera uma lista de campanhas em uma conta |
| Mostrar membros da lista |
Mostrar todos os membros de uma lista |
| Nova campanha (V2) |
Crie uma nova campanha com base em um tipo de campanha, lista de destinatários e configurações de campanha (linha de assunto, título, from_name e reply_to) (V2). |
| Nova campanha [PRETERIDA] |
Esta ação foi preterida. Em vez disso, use Nova Campanha (V2 ).
|
| Nova Lista |
Criar uma nova lista em sua conta do MailChimp |
| Obter todas as listas |
Localizar todas as listas para o usuário atual |
| Remover Membro da lista |
Exclua um membro de uma lista. |
Adicionar membro à lista
Adicionar ou atualizar um membro de lista
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
A ID exclusiva da lista |
|
Tipo de email
|
email_type | string |
Tipo de email que este membro pediu para obter ('html' ou 'text') |
|
|
Situação
|
status | True | string |
Status atual do assinante. Valores possíveis: inscrito, não assinado, limpo, pendente |
|
Primeiro Nome
|
FNAME | string |
Nome do assinante |
|
|
Apelido
|
LNAME | string |
Sobrenome do assinante |
|
|
Linguagem
|
language | string |
Se definido/detectado, o idioma do assinante |
|
|
VIP
|
vip | boolean |
Status VIP para assinante |
|
|
Latitude
|
latitude | float |
A latitude do local |
|
|
Longitude
|
longitude | float |
A longitude do local |
|
|
Endereço eletrônico
|
email_address | True | string |
Endereço de email para um assinante |
Retornos
Modelo de resultado do membro
- Corpo
- MemberResponseModel
Assinar ou cancelar a assinatura de membros da lista
Inscrever ou cancelar a assinatura de membros da lista do Lote.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
A ID exclusiva da lista |
|
Ignorar validação de mesclagem
|
skip_merge_validation | boolean |
Permite que os dados de membro sejam aceitos sem valores de campo de mesclagem |
|
|
Ignorar verificação duplicada
|
skip_duplicate_check | boolean |
Ignora duplicatas enviadas na solicitação |
|
|
Tipo de email
|
email_type | string |
Tipo de email que este membro pediu para obter ('html' ou 'text') |
|
|
Situação
|
status | True | string |
Status atual do assinante. Valores possíveis: inscrito, não assinado, limpo, pendente |
|
Primeiro Nome
|
FNAME | string |
Nome do assinante |
|
|
Apelido
|
LNAME | string |
Sobrenome do assinante |
|
|
Linguagem
|
language | string |
Se definido/detectado, o idioma do assinante |
|
|
VIP
|
vip | boolean |
Status VIP para assinante |
|
|
Latitude
|
latitude | float |
A latitude do local |
|
|
Longitude
|
longitude | float |
A longitude do local |
|
|
Endereço eletrônico
|
email_address | True | string |
Endereço de email para um assinante |
|
Atualizar membros existentes
|
update_existing | boolean |
Se essa operação em lote alterará o status da assinatura dos membros existentes. |
Retornos
Resposta ao assinar ou cancelar a assinatura de membros da lista em um lote
Atualizar informações do membro
Atualize as informações de um membro de lista específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
A ID exclusiva da lista |
|
Email do membro
|
member_email | True | string |
O endereço de email exclusivo do membro a ser atualizado |
|
Tipo de email
|
email_type | string |
Tipo de email que este membro pediu para obter ('html' ou 'text') |
|
|
Situação
|
status | True | string |
Status atual do assinante. Valores possíveis: inscrito, não assinado, limpo, pendente |
|
Primeiro Nome
|
FNAME | string |
Nome do assinante |
|
|
Apelido
|
LNAME | string |
Sobrenome do assinante |
|
|
Linguagem
|
language | string |
Se definido/detectado, o idioma do assinante |
|
|
VIP
|
vip | boolean |
Status VIP para assinante |
|
|
Latitude
|
latitude | float |
A latitude do local |
|
|
Longitude
|
longitude | float |
A longitude do local |
Retornos
Modelo de resultado do membro
- Corpo
- MemberResponseModel
Enviar campanha (versão prévia)
Enviar uma campanha existente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Campanha
|
campaign_id | True | string |
A ID exclusiva da lista |
Listar campanhas
Esta operação recupera uma lista de campanhas em uma conta
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Campaigns
|
campaigns | array of CampaignResponseModel |
Uma matriz de objetos, cada um representando uma campanha |
Mostrar membros da lista
Mostrar todos os membros de uma lista
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
A ID exclusiva da lista |
|
Resultados máximos
|
count | integer |
O número de registros a serem retornados. O valor padrão é 10. O valor máximo é 1000 |
|
|
Offset
|
offset | integer |
O número de registros de uma coleção a ser ignorada. Valor padrão é 0. |
Retornos
Resposta ao consultar todos os membros em uma lista
Nova campanha (V2)
Crie uma nova campanha com base em um tipo de campanha, lista de destinatários e configurações de campanha (linha de assunto, título, from_name e reply_to) (V2).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de Campanha
|
type | True | string |
Há quatro tipos de campanhas que você pode criar no MailChimp. As campanhas de Divisão A/B foram preteridas e as campanhas de variação devem ser usadas. Valores possíveis: regular, texto sem formatação, absplit, rss, variação |
|
ID da lista
|
list_id | True | string |
A ID de lista exclusiva |
|
ID do segmento salvo
|
saved_segment_id | integer |
A ID de um segmento salvo existente |
|
|
Tipo de correspondência
|
match | string |
Tipo de correspondência de segmento: Valores possíveis: qualquer, todos |
|
|
Linha de Assunto da Campanha
|
subject_line | True | string |
A linha de assunto da campanha |
|
Title
|
title | string |
O título da campanha |
|
|
Nome do Remetente
|
from_name | True | string |
O nome 'from' na campanha (não um endereço de email) |
|
Responder ao endereço
|
reply_to | True | string |
O endereço de email de resposta para a campanha |
|
Conversa
|
use_conversation | boolean |
Usar o recurso de Conversa do MailChimp para gerenciar respostas fora do escritório |
|
|
Nome
|
to_name | string |
O nome 'To' personalizado da campanha. Normalmente, o primeiro campo de mesclagem de nome |
|
|
ID da pasta
|
folder_id | string |
Se a campanha estiver listada em uma pasta, a ID dessa pasta |
|
|
Authentication
|
authenticate | boolean |
Se o MailChimp autenticou a campanha. Padrões como true |
|
|
Rodapé automático
|
auto_footer | boolean |
Anexar automaticamente o rodapé padrão do MailChimp à campanha |
|
|
CSS embutido
|
inline_css | boolean |
Embutido automaticamente o CSS incluído no conteúdo da campanha |
|
|
Tweet automático
|
auto_tweet | boolean |
Twittar automaticamente um link para a página de arquivo morto da campanha quando a campanha for enviada |
|
|
Postagem automática no Facebook
|
auto_fb_post | array of integer |
Uma matriz de IDs de página do Facebook para postar automaticamente |
|
|
Comentários do Facebook
|
fb_comments | boolean |
Permite comentários do Facebook sobre a campanha (também habilita a barra de ferramentas do Arquivo de Campanha). Padrões como true |
|
|
Critérios vencedores
|
winner_criteria | string |
A combinação que executa o melhor. Isso pode ser determinado automaticamente clicando em taxa, taxa aberta ou receita total ou você pode escolher manualmente com base nos dados de relatório que você achar mais valiosos. Para send_time de teste de Campanhas Multivariadas, winner_critera é ignorado. Para Campanhas Multivariadas com 'manual' como o winner_citeria, o vencedor deve ser escolhido no aplicativo Web MailChimp |
|
|
Tempo de Espera
|
wait_time | integer |
O número de minutos a aguardar antes de escolher a campanha vencedora. O valor de wait_time deve ser maior que 0 e em horas inteiras, especificado em minutos |
|
|
Tamanho do teste
|
test_size | integer |
O percentual de destinatários para o qual enviar as combinações de teste deve ser um valor entre 10 e 100 |
|
|
Linhas de Assunto
|
subject_lines | array of string |
As possíveis linhas de assunto a serem testadas. Se nenhuma linha de assunto for fornecida, settings.subject_line será usado |
|
|
Enviar Horários
|
send_times | array of string |
Os tempos de envio possíveis para teste. Os horários fornecidos devem estar no formato YYYY-MM-DD HH:MM:SS. Se send_times forem fornecidos para teste, o test_size será definido como 100% e winner_criteria será ignorado |
|
|
De Nomes
|
from_names | array of string |
O possível de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se nenhum from_names for fornecido, settings.from_name será usado |
|
|
Responder a endereços
|
reply_to_addresses | array of string |
O possível de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se nenhum from_names for fornecido, settings.from_name será usado |
|
|
Abertas
|
opens | boolean |
Se o controle é aberto. O padrão é true. Não pode ser definido como false para campanhas variadas |
|
|
Acompanhamento de clique em HTML
|
html_clicks | boolean |
Se os cliques devem ser acompanhados na versão HTML da campanha. O padrão é true. Não pode ser definido como false para campanhas variadas |
|
|
Plain-Text Clique em Acompanhamento
|
text_clicks | boolean |
Se os cliques devem ser acompanhados na versão de texto sem formatação da campanha. O padrão é true. Não pode ser definido como false para campanhas variadas |
|
|
Acompanhamento de metas do MailChimp
|
goal_tracking | boolean |
Se deseja habilitar o rastreamento de metas |
|
|
Acompanhamento do eCommerce360
|
ecomm360 | boolean |
Se deseja habilitar o acompanhamento do eCommerce360 |
|
|
Acompanhamento do Google Analytics
|
google_analytics | string |
A lesma personalizada para o acompanhamento do Google Analytics (no máximo 50 bytes) |
|
|
Acompanhamento do ClickTale Analytics
|
clicktale | string |
A lesma personalizada para o acompanhamento do ClickTale (máximo de 50 bytes) |
|
|
Campanha salesforce
|
campaign | boolean |
Criar uma campanha em uma conta conectada do Salesforce |
|
|
Observação do Salesforce
|
notes | boolean |
Atualizar notas de contato para uma campanha com base em endereços de email do assinante |
|
|
Campanha Highrise
|
campaign | boolean |
Criar uma campanha em uma conta do Highrise conectada |
|
|
Nota highrise
|
notes | boolean |
Atualizar notas de contato para uma campanha com base em endereços de email do assinante |
|
|
Observação da cápsula
|
notes | boolean |
Atualizar notas de contato para uma campanha com base em endereços de email do assinante |
|
|
URL do feed
|
feed_url | string |
A URL do feed RSS |
|
|
Frequência
|
frequency | string |
A frequência da campanha do RSS |
|
|
Restringir imagens RSS
|
constrain_rss_img | string |
Se o CSS deve ser adicionado a imagens no feed do RSS para restringir sua largura em campanhas |
|
|
Hora de envio
|
hour | integer |
A hora para enviar a campanha no horário local. As horas aceitáveis são de 0 a 23. Por exemplo, '4' seria 4:00 no fuso horário padrão da sua conta |
|
|
Domingo
|
sunday | boolean |
Envia a campanha diária do RSS aos domingos |
|
|
Segunda-feira
|
monday | boolean |
Envia a campanha diária do RSS às segundas-feiras |
|
|
Terça-feira
|
tuesday | boolean |
Envia a campanha diária do RSS às terças-feiras |
|
|
Quarta-feira
|
wednesday | boolean |
Envia a campanha diária do RSS às quartas-feiras |
|
|
Quinta-feira
|
thursday | boolean |
Envia a campanha diária do RSS às quintas-feiras |
|
|
Sexta-feira
|
friday | boolean |
Envia a campanha diária do RSS às sextas-feiras |
|
|
Sábado
|
saturday | boolean |
Envia a campanha diária do RSS aos sábados |
|
|
Dia de Envio Semanal
|
weekly_send_day | string |
O dia da semana para enviar uma campanha semanal do RSS |
|
|
Dia de Envio Mensal
|
monthly_send_date | float |
O dia do mês para enviar uma campanha mensal do RSS. Os dias aceitáveis são 1-32, onde '0' é sempre o último dia de um mês. Meses com menos do que o número selecionado de dias não terão uma campanha do RSS enviada naquele dia. Por exemplo, as Campanhas RSS definidas para enviar no dia 30 não sairão em fevereiro |
|
|
URL da imagem
|
image_url | string |
A URL da imagem de cabeçalho do cartão |
|
|
Descrição da campanha
|
description | string |
Um breve resumo da campanha a ser exibida |
|
|
Title
|
title | string |
O título do cartão. Normalmente, a linha de assunto da campanha |
Retornos
Novo modelo de resultado de campanha
- Corpo
- CampaignResponseModel
Nova campanha [PRETERIDA]
Esta ação foi preterida. Em vez disso, use Nova Campanha (V2 ).
Criar uma nova campanha com base em um tipo de campanha, lista de destinatários e configurações de campanha (linha de assunto, título, from_name e reply_to)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de Campanha
|
type | True | string |
Há quatro tipos de campanhas que você pode criar no MailChimp. As campanhas de Divisão A/B foram preteridas e as campanhas de variação devem ser usadas. Valores possíveis: regular, texto sem formatação, absplit, rss, variação |
|
ID da lista
|
list_id | True | string |
A ID de lista exclusiva |
|
ID do segmento salvo
|
saved_segment_id | integer |
A ID de um segmento salvo existente |
|
|
Tipo de correspondência
|
match | string |
Tipo de correspondência de segmento: Valores possíveis: qualquer, todos |
|
|
Linha de Assunto da Campanha
|
subject_line | True | string |
A linha de assunto da campanha |
|
Title
|
title | string |
O título da campanha |
|
|
Nome do Remetente
|
from_name | True | string |
O nome 'from' na campanha (não um endereço de email) |
|
Responder ao endereço
|
reply_to | True | string |
O endereço de email de resposta para a campanha |
|
Conversa
|
use_conversation | boolean |
Usar o recurso de Conversa do MailChimp para gerenciar respostas fora do escritório |
|
|
Nome
|
to_name | string |
O nome 'To' personalizado da campanha. Normalmente, o primeiro campo de mesclagem de nome |
|
|
ID da pasta
|
folder_id | integer |
Se a campanha estiver listada em uma pasta, a ID dessa pasta |
|
|
Authentication
|
authenticate | boolean |
Se o MailChimp autenticou a campanha. Padrões como true |
|
|
Rodapé automático
|
auto_footer | boolean |
Anexar automaticamente o rodapé padrão do MailChimp à campanha |
|
|
CSS embutido
|
inline_css | boolean |
Embutido automaticamente o CSS incluído no conteúdo da campanha |
|
|
Tweet automático
|
auto_tweet | boolean |
Twittar automaticamente um link para a página de arquivo morto da campanha quando a campanha for enviada |
|
|
Postagem automática no Facebook
|
auto_fb_post | array of integer |
Uma matriz de IDs de página do Facebook para postar automaticamente |
|
|
Comentários do Facebook
|
fb_comments | boolean |
Permite comentários do Facebook sobre a campanha (também habilita a barra de ferramentas do Arquivo de Campanha). Padrões como true |
|
|
Critérios vencedores
|
winner_criteria | string |
A combinação que executa o melhor. Isso pode ser determinado automaticamente clicando em taxa, taxa aberta ou receita total ou você pode escolher manualmente com base nos dados de relatório que você achar mais valiosos. Para send_time de teste de Campanhas Multivariadas, winner_critera é ignorado. Para Campanhas Multivariadas com 'manual' como o winner_citeria, o vencedor deve ser escolhido no aplicativo Web MailChimp |
|
|
Tempo de Espera
|
wait_time | integer |
O número de minutos a aguardar antes de escolher a campanha vencedora. O valor de wait_time deve ser maior que 0 e em horas inteiras, especificado em minutos |
|
|
Tamanho do teste
|
test_size | integer |
O percentual de destinatários para o qual enviar as combinações de teste deve ser um valor entre 10 e 100 |
|
|
Linhas de Assunto
|
subject_lines | array of string |
As possíveis linhas de assunto a serem testadas. Se nenhuma linha de assunto for fornecida, settings.subject_line será usado |
|
|
Enviar Horários
|
send_times | array of string |
Os tempos de envio possíveis para teste. Os horários fornecidos devem estar no formato YYYY-MM-DD HH:MM:SS. Se send_times forem fornecidos para teste, o test_size será definido como 100% e winner_criteria será ignorado |
|
|
De Nomes
|
from_names | array of string |
O possível de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se nenhum from_names for fornecido, settings.from_name será usado |
|
|
Responder a endereços
|
reply_to_addresses | array of string |
O possível de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se nenhum from_names for fornecido, settings.from_name será usado |
|
|
Abertas
|
opens | boolean |
Se o controle é aberto. O padrão é true. Não pode ser definido como false para campanhas variadas |
|
|
Acompanhamento de clique em HTML
|
html_clicks | boolean |
Se os cliques devem ser acompanhados na versão HTML da campanha. O padrão é true. Não pode ser definido como false para campanhas variadas |
|
|
Plain-Text Clique em Acompanhamento
|
text_clicks | boolean |
Se os cliques devem ser acompanhados na versão de texto sem formatação da campanha. O padrão é true. Não pode ser definido como false para campanhas variadas |
|
|
Acompanhamento de metas do MailChimp
|
goal_tracking | boolean |
Se deseja habilitar o rastreamento de metas |
|
|
Acompanhamento do eCommerce360
|
ecomm360 | boolean |
Se deseja habilitar o acompanhamento do eCommerce360 |
|
|
Acompanhamento do Google Analytics
|
google_analytics | string |
A lesma personalizada para o acompanhamento do Google Analytics (no máximo 50 bytes) |
|
|
Acompanhamento do ClickTale Analytics
|
clicktale | string |
A lesma personalizada para o acompanhamento do ClickTale (máximo de 50 bytes) |
|
|
Campanha salesforce
|
campaign | boolean |
Criar uma campanha em uma conta conectada do Salesforce |
|
|
Observação do Salesforce
|
notes | boolean |
Atualizar notas de contato para uma campanha com base em endereços de email do assinante |
|
|
Campanha Highrise
|
campaign | boolean |
Criar uma campanha em uma conta do Highrise conectada |
|
|
Nota highrise
|
notes | boolean |
Atualizar notas de contato para uma campanha com base em endereços de email do assinante |
|
|
Observação da cápsula
|
notes | boolean |
Atualizar notas de contato para uma campanha com base em endereços de email do assinante |
|
|
URL do feed
|
feed_url | string |
A URL do feed RSS |
|
|
Frequência
|
frequency | string |
A frequência da campanha do RSS |
|
|
Restringir imagens RSS
|
constrain_rss_img | string |
Se o CSS deve ser adicionado a imagens no feed do RSS para restringir sua largura em campanhas |
|
|
Hora de envio
|
hour | integer |
A hora para enviar a campanha no horário local. As horas aceitáveis são de 0 a 23. Por exemplo, '4' seria 4:00 no fuso horário padrão da sua conta |
|
|
Domingo
|
sunday | boolean |
Envia a campanha diária do RSS aos domingos |
|
|
Segunda-feira
|
monday | boolean |
Envia a campanha diária do RSS às segundas-feiras |
|
|
Terça-feira
|
tuesday | boolean |
Envia a campanha diária do RSS às terças-feiras |
|
|
Quarta-feira
|
wednesday | boolean |
Envia a campanha diária do RSS às quartas-feiras |
|
|
Quinta-feira
|
thursday | boolean |
Envia a campanha diária do RSS às quintas-feiras |
|
|
Sexta-feira
|
friday | boolean |
Envia a campanha diária do RSS às sextas-feiras |
|
|
Sábado
|
saturday | boolean |
Envia a campanha diária do RSS aos sábados |
|
|
Dia de Envio Semanal
|
weekly_send_day | string |
O dia da semana para enviar uma campanha semanal do RSS |
|
|
Dia de Envio Mensal
|
monthly_send_date | float |
O dia do mês para enviar uma campanha mensal do RSS. Os dias aceitáveis são 1-32, onde '0' é sempre o último dia de um mês. Meses com menos do que o número selecionado de dias não terão uma campanha do RSS enviada naquele dia. Por exemplo, as Campanhas RSS definidas para enviar no dia 30 não sairão em fevereiro |
|
|
URL da imagem
|
image_url | string |
A URL da imagem de cabeçalho do cartão |
|
|
Descrição da campanha
|
description | string |
Um breve resumo da campanha a ser exibida |
|
|
Title
|
title | string |
O título do cartão. Normalmente, a linha de assunto da campanha |
Retornos
Novo modelo de resultado de campanha
- Corpo
- CampaignResponseModel
Nova Lista
Criar uma nova lista em sua conta do MailChimp
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da Lista
|
name | True | string |
O nome da lista |
|
Nome da Empresa
|
company | True | string |
O nome da empresa para a lista |
|
Linha de endereço 1
|
address1 | True | string |
O endereço da rua para o contato da lista |
|
Linha de endereço 2
|
address2 | string |
O endereço da rua para o contato da lista |
|
|
City
|
city | True | string |
A cidade para o contato da lista |
|
Estado
|
state | True | string |
O estado do contato de lista |
|
Código postal
|
zip | True | string |
O cep ou cep do contato da lista |
|
Código do país
|
country | True | string |
Um código de país ISO3166 de dois caracteres. Padrão para os EUA se inválido |
|
Número de Telefone
|
phone | True | string |
O número de telefone do contato da lista |
|
Lembrete de permissão
|
permission_reminder | True | string |
Texto para lembrar as pessoas como elas se inscreveram nesta lista |
|
Usar a Barra de Arquivos
|
use_archive_bar | boolean |
Se as campanhas para esta lista usam a Barra de Arquivos em arquivos por padrão |
|
|
Nome do remetente
|
from_name | True | string |
O padrão do nome das campanhas enviadas para esta lista |
|
Endereço de email do remetente
|
from_email | True | string |
O padrão de email para campanhas enviadas para esta lista |
|
Assunto
|
subject | True | string |
A linha de assunto padrão para campanhas enviadas para esta lista |
|
Linguagem
|
language | True | string |
O idioma padrão dos formulários desta lista |
|
Notificar sobre a assinatura
|
notify_on_subscribe | string |
O endereço de email para o qual enviar notificações de assinatura |
|
|
Notificar sobre cancelar assinatura
|
notify_on_unsubscribe | string |
O endereço de email para o qual enviar notificações de cancelamento de assinatura |
|
|
Permitir que os usuários escolham entre HTML e texto sem formatação (true/false)?
|
email_type_option | True | boolean |
Quando definido como true, os assinantes podem escolher se desejam receber emails HTML ou de texto sem formatação. Quando definido como false, os assinantes receberão emails HTML, com um backup alternativo de texto sem formatação |
|
Visibilidade
|
visibility | string |
Se esta lista é pública ou privada |
Retornos
Criar um novo modelo de resultado de lista
Obter todas as listas
Localizar todas as listas para o usuário atual
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Resultados máximos
|
count | integer |
O número de registros a serem retornados. O valor padrão é 10. O valor máximo é 1000 |
|
|
Offset
|
offset | integer |
O número de registros de uma coleção a ser ignorada. Valor padrão é 0. |
Retornos
Resposta ao obter listas
- Corpo
- GetListsResponseModel
Remover Membro da lista
Exclua um membro de uma lista.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
A ID exclusiva da lista |
|
Email do membro
|
member_email | True | string |
O endereço de email do membro a ser excluído |
Gatilhos
| Quando um membro foi adicionado a uma lista |
Dispara um fluxo de trabalho quando um novo membro é adicionado a uma lista |
| Quando uma nova lista é criada |
Dispara um fluxo de trabalho quando uma nova lista é criada |
Quando um membro foi adicionado a uma lista
Dispara um fluxo de trabalho quando um novo membro é adicionado a uma lista
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
A ID exclusiva da lista |
Retornos
Resposta ao obter membros em uma lista
- Corpo
- GetMembersResponseModel
Quando uma nova lista é criada
Dispara um fluxo de trabalho quando uma nova lista é criada
Retornos
Resposta ao obter listas
- Corpo
- GetListsResponseModel
Definições
Recipient
Configurações da campanha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da lista
|
list_id | string |
A ID de lista exclusiva |
|
segment_opts
|
segment_opts | Segment_Opts |
Um objeto que representa todas as opções de segmentação |
Variate_Settings
Configurações da campanha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Critérios vencedores
|
winner_criteria | string |
A combinação que executa o melhor. Isso pode ser determinado automaticamente clicando em taxa, taxa aberta ou receita total ou você pode escolher manualmente com base nos dados de relatório que você achar mais valiosos. Para send_time de teste de Campanhas Multivariadas, winner_critera é ignorado. Para Campanhas Multivariadas com 'manual' como o winner_citeria, o vencedor deve ser escolhido no aplicativo Web MailChimp |
|
Tempo de Espera
|
wait_time | integer |
O número de minutos a aguardar antes de escolher a campanha vencedora. O valor de wait_time deve ser maior que 0 e em horas inteiras, especificado em minutos |
|
Tamanho do teste
|
test_size | integer |
O percentual de destinatários para o qual enviar as combinações de teste deve ser um valor entre 10 e 100 |
|
Linhas de Assunto
|
subject_lines | array of string |
As possíveis linhas de assunto a serem testadas. Se nenhuma linha de assunto for fornecida, settings.subject_line será usado |
|
Enviar Horários
|
send_times | array of string |
Os tempos de envio possíveis para teste. Os horários fornecidos devem estar no formato YYYY-MM-DD HH:MM:SS. Se send_times forem fornecidos para teste, o test_size será definido como 100% e winner_criteria será ignorado |
|
De Nomes
|
from_names | array of string |
O possível de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se nenhum from_names for fornecido, settings.from_name será usado |
|
Responder a endereços
|
reply_to_addresses | array of string |
O possível de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se nenhum from_names for fornecido, settings.from_name será usado |
Acompanhamento
Configurações da campanha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Abertas
|
opens | boolean |
Se o controle é aberto. O padrão é true. Não pode ser definido como false para campanhas variadas |
|
Acompanhamento de clique em HTML
|
html_clicks | boolean |
Se os cliques devem ser acompanhados na versão HTML da campanha. O padrão é true. Não pode ser definido como false para campanhas variadas |
|
Plain-Text Clique em Acompanhamento
|
text_clicks | boolean |
Se os cliques devem ser acompanhados na versão de texto sem formatação da campanha. O padrão é true. Não pode ser definido como false para campanhas variadas |
|
Acompanhamento de metas do MailChimp
|
goal_tracking | boolean |
Se deseja habilitar o rastreamento de metas |
|
Acompanhamento do eCommerce360
|
ecomm360 | boolean |
Se deseja habilitar o acompanhamento do eCommerce360 |
|
Acompanhamento do Google Analytics
|
google_analytics | string |
A lesma personalizada para o acompanhamento do Google Analytics (no máximo 50 bytes) |
|
Acompanhamento do ClickTale Analytics
|
clicktale | string |
A lesma personalizada para o acompanhamento do ClickTale (máximo de 50 bytes) |
|
salesforce
|
salesforce | Salesforce |
Opções de acompanhamento do Salesforce para uma campanha. Deve estar usando a integração interna do MailChimp com o Salesforce |
|
highrise
|
highrise | Highrise |
Opções de acompanhamento do Highrise para uma campanha. Deve estar usando a integração interna do MailChimp no Highrise |
|
cápsula
|
capsule | Capsule |
Opções de acompanhamento de cápsulas para uma campanha. Deve estar usando a integração interna da Cápsula do MailChimp |
RSS_Opts
Opções do RSS para uma campanha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL do feed
|
feed_url | string |
A URL do feed RSS |
|
Frequência
|
frequency | string |
A frequência da campanha do RSS |
|
Restringir imagens RSS
|
constrain_rss_img | string |
Se o CSS deve ser adicionado a imagens no feed do RSS para restringir sua largura em campanhas |
|
Cronograma
|
schedule | Schedule |
O agendamento para enviar a campanha do RSS |
Social_Card
Configurações da campanha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL da imagem
|
image_url | string |
A URL da imagem de cabeçalho do cartão |
|
Descrição da campanha
|
description | string |
Um breve resumo da campanha a ser exibida |
|
Title
|
title | string |
O título do cartão. Normalmente, a linha de assunto da campanha |
Segment_Opts
Um objeto que representa todas as opções de segmentação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do segmento salvo
|
saved_segment_id | integer |
A ID de um segmento salvo existente |
|
Tipo de correspondência
|
match | string |
Tipo de correspondência de segmento: Valores possíveis: qualquer, todos |
Salesforce
Opções de acompanhamento do Salesforce para uma campanha. Deve estar usando a integração interna do MailChimp com o Salesforce
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Campanha salesforce
|
campaign | boolean |
Criar uma campanha em uma conta conectada do Salesforce |
|
Observação do Salesforce
|
notes | boolean |
Atualizar notas de contato para uma campanha com base em endereços de email do assinante |
Highrise
Opções de acompanhamento do Highrise para uma campanha. Deve estar usando a integração interna do MailChimp no Highrise
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Campanha Highrise
|
campaign | boolean |
Criar uma campanha em uma conta do Highrise conectada |
|
Nota highrise
|
notes | boolean |
Atualizar notas de contato para uma campanha com base em endereços de email do assinante |
Cápsula
Opções de acompanhamento de cápsulas para uma campanha. Deve estar usando a integração interna da Cápsula do MailChimp
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Observação da cápsula
|
notes | boolean |
Atualizar notas de contato para uma campanha com base em endereços de email do assinante |
Cronograma
O agendamento para enviar a campanha do RSS
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Hora de envio
|
hour | integer |
A hora para enviar a campanha no horário local. As horas aceitáveis são de 0 a 23. Por exemplo, '4' seria 4:00 no fuso horário padrão da sua conta |
|
daily_send
|
daily_send | Daily_Send |
Os dias da semana para enviar uma campanha diária do RSS. |
|
Dia de Envio Semanal
|
weekly_send_day | string |
O dia da semana para enviar uma campanha semanal do RSS |
|
Dia de Envio Mensal
|
monthly_send_date | float |
O dia do mês para enviar uma campanha mensal do RSS. Os dias aceitáveis são 1-32, onde '0' é sempre o último dia de um mês. Meses com menos do que o número selecionado de dias não terão uma campanha do RSS enviada naquele dia. Por exemplo, as Campanhas RSS definidas para enviar no dia 30 não sairão em fevereiro |
Daily_Send
Os dias da semana para enviar uma campanha diária do RSS.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Domingo
|
sunday | boolean |
Envia a campanha diária do RSS aos domingos |
|
Segunda-feira
|
monday | boolean |
Envia a campanha diária do RSS às segundas-feiras |
|
Terça-feira
|
tuesday | boolean |
Envia a campanha diária do RSS às terças-feiras |
|
Quarta-feira
|
wednesday | boolean |
Envia a campanha diária do RSS às quartas-feiras |
|
Quinta-feira
|
thursday | boolean |
Envia a campanha diária do RSS às quintas-feiras |
|
Sexta-feira
|
friday | boolean |
Envia a campanha diária do RSS às sextas-feiras |
|
Sábado
|
saturday | boolean |
Envia a campanha diária do RSS aos sábados |
CampaignResponseModel
Novo modelo de resultado de campanha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da Campanha
|
id | string |
Uma cadeia de caracteres que identifica exclusivamente esta campanha |
|
Tipo de Campanha
|
type | string |
Há quatro tipos de campanhas que você pode criar no MailChimp. As campanhas de Divisão A/B foram preteridas e as campanhas de variação devem ser usadas em vez disso |
|
Hora de Criação
|
create_time | string |
A data e a hora em que a campanha foi criada |
|
URL de arquivo morto
|
archive_url | string |
O link para a versão de arquivo morto da campanha |
|
Situação
|
status | string |
O link para a versão de arquivo morto da campanha |
|
Emails Enviados
|
emails_sent | integer |
O número total de emails enviados para esta campanha |
|
Tempo de Envio
|
send_time | string |
A hora e a data em que uma campanha foi enviada |
|
Tipo de conteúdo
|
content_type | string |
Como o conteúdo da campanha é montado ('template', 'drag_and_drop', 'html', 'url') |
|
List
|
recipient | array of Recipient |
Listar configurações da campanha |
|
configurações
|
settings | SettingsV2 |
Configurações da campanha |
|
variate_settings
|
variate_settings | Variate_Settings |
Configurações da campanha |
|
acompanhamento
|
tracking | Tracking |
Configurações da campanha |
|
rss_opts
|
rss_opts | RSS_Opts |
Opções do RSS para uma campanha |
|
ab_split_opts
|
ab_split_opts | AB_Split_Opts |
Opções de teste A/B para uma campanha |
|
social_card
|
social_card | Social_Card |
Configurações da campanha |
|
report_summary
|
report_summary | Report_Summary |
Para campanhas enviadas, um resumo de aberturas, cliques e cancelamento de assinaturas |
|
delivery_status
|
delivery_status | Delivery_Status |
Atualizações em campanhas no processo de envio |
|
_Links
|
_links | array of Link |
Uma lista de tipos de link e descrições para os documentos de esquema de API |
SettingsV2
Configurações da campanha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Linha de Assunto da Campanha
|
subject_line | string |
A linha de assunto da campanha |
|
Title
|
title | string |
O título da campanha |
|
Nome do Remetente
|
from_name | string |
O nome 'from' na campanha (não um endereço de email) |
|
Responder ao endereço
|
reply_to | string |
O endereço de email de resposta para a campanha |
|
Conversa
|
use_conversation | boolean |
Usar o recurso de Conversa do MailChimp para gerenciar respostas fora do escritório |
|
Nome
|
to_name | string |
O nome 'To' personalizado da campanha. Normalmente, o primeiro campo de mesclagem de nome |
|
ID da pasta
|
folder_id | string |
Se a campanha estiver listada em uma pasta, a ID dessa pasta |
|
Authentication
|
authenticate | boolean |
Se o MailChimp autenticou a campanha. Padrões como true |
|
Rodapé automático
|
auto_footer | boolean |
Anexar automaticamente o rodapé padrão do MailChimp à campanha |
|
CSS embutido
|
inline_css | boolean |
Embutido automaticamente o CSS incluído no conteúdo da campanha |
|
Tweet automático
|
auto_tweet | boolean |
Twittar automaticamente um link para a página de arquivo morto da campanha quando a campanha for enviada |
|
Postagem automática no Facebook
|
auto_fb_post | array of integer |
Uma matriz de IDs de página do Facebook para postar automaticamente |
|
Comentários do Facebook
|
fb_comments | boolean |
Permite comentários do Facebook sobre a campanha (também habilita a barra de ferramentas do Arquivo de Campanha). Padrões como true |
AB_Split_Opts
Opções de teste A/B para uma campanha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Teste de divisão
|
split_test | string |
O tipo de ab split a ser executado |
|
Escolher Vencedor
|
pick_winner | string |
Como devemos avaliar um vencedor. Com base em 'opens', 'clicks' ou 'manual' |
|
Tempo de Espera
|
wait_units | string |
Como unidade de tempo para medir o vencedor ('horas' ou 'dias'). Isso não pode ser alterado depois que uma campanha é enviada |
|
Tempo de Espera
|
wait_time | integer |
A quantidade de tempo para esperar antes de escolher um vencedor. Isso não pode ser alterado depois que uma campanha é enviada |
|
Tamanho da Divisão
|
split_size | integer |
O tamanho dos grupos divididos. As campanhas divididas com base no "agendamento" são forçadas a ter uma divisão 50/50. Inteiros divididos válidos estão entre 1 e 50 |
|
Do Grupo de Nomes A
|
from_name_a | string |
Para campanhas divididas em 'De Nome', o nome do Grupo A |
|
Do Grupo de Nomes B
|
from_name_b | string |
Para campanhas divididas em 'De Nome', o nome do Grupo B |
|
Responder grupo de email A
|
reply_email_a | string |
Para campanhas divididas em 'De Nome', o endereço de resposta para o Grupo A |
|
Responder grupo de email B
|
reply_email_b | string |
Para campanhas divididas em 'De Nome', o endereço de resposta para o Grupo B |
|
Grupo de Linhas de Assunto A
|
subject_a | string |
Para campanhas divididas em 'Linha de Assunto', a linha de assunto do Grupo A |
|
Grupo de Linhas de Assunto B
|
subject_b | string |
Para campanhas divididas em 'Linha de Assunto', a linha de assunto do Grupo B |
|
Enviar Grupo de Tempo A
|
send_time_a | string |
O tempo de envio do Grupo A |
|
Grupo de Tempo de Envio B
|
send_time_b | string |
O tempo de envio para o Grupo B |
|
Vencedor do Tempo de Envio
|
send_time_winner | string |
O tempo de envio para a versão vencedora |
Report_Summary
Para campanhas enviadas, um resumo de aberturas, cliques e cancelamento de assinaturas
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Automação é aberta
|
opens | integer |
O número total de aberturas para uma campanha |
|
Aberturas Exclusivas
|
unique_opens | integer |
O número de aberturas exclusivas |
|
Taxa aberta
|
open_rate | float |
O número de aberturas exclusivas é dividido pelo número total de entregas bem-sucedidas |
|
Total de cliques
|
clicks | integer |
O número total de cliques para uma campanha |
|
Cliques exclusivos do Assinante
|
subscriber_clicks | float |
O número de cliques exclusivos |
|
Clique em Taxa
|
click_rate | float |
O número de cliques exclusivos divididos pelo número total de entregas bem-sucedidas |
Delivery_Status
Atualizações em campanhas no processo de envio
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Staut de entrega habilitado
|
enabled | boolean |
Se o Status de Entrega de Campanha está habilitado para essa conta e campanha |
|
Cancelável de Campanha
|
can_cancel | boolean |
Se um envio de campanha pode ser cancelado |
|
Status da entrega da campanha
|
status | string |
O estado atual de uma entrega de campanha |
|
Emails Enviados
|
emails_sent | integer |
O número total de e-mails confirmados enviados para esta campanha até agora |
|
Emails Cancelados
|
emails_canceled | integer |
O número total de emails cancelados para esta campanha |
Link
Opções de acompanhamento de cápsulas para uma campanha. Deve estar usando a integração interna da Cápsula do MailChimp
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Rel
|
rel | string |
Assim como acontece com um atributo HTML 'rel', isso descreve o tipo de link |
|
Href
|
href | string |
Essa propriedade contém uma URL totalmente qualificada que pode ser chamada para recuperar o recurso vinculado ou executar a ação vinculada |
|
Método
|
method | string |
O método HTTP que deve ser usado ao acessar a URL definida em 'href'. (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD) |
|
Esquema de destino
|
targetSchema | string |
Para GETs, essa é uma URL que representa o esquema ao qual a resposta deve estar em conformidade |
|
Schema
|
schema | string |
Para métodos HTTP que podem receber corpos (POST e PUT), essa é uma URL que representa o esquema ao qual o corpo deve estar em conformidade |
Contato
Opções de acompanhamento de cápsulas para uma campanha. Deve estar usando a integração interna da Cápsula do MailChimp
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome da Empresa
|
company | string |
O nome da empresa para a lista |
|
Linha de endereço 1
|
address1 | string |
O endereço da rua para o contato da lista |
|
Linha de endereço 2
|
address2 | string |
O endereço da rua para o contato da lista |
|
City
|
city | string |
A cidade para o contato da lista |
|
Estado
|
state | string |
O estado do contato de lista |
|
Código postal
|
zip | string |
O cep ou cep do contato da lista |
|
Código do país
|
country | string |
Um código de país ISO3166 de dois caracteres. Padrão para os EUA se inválido |
|
Número de Telefone
|
phone | string |
O número de telefone do contato da lista |
Campaign_Defaults
Opções de acompanhamento de cápsulas para uma campanha. Deve estar usando a integração interna da Cápsula do MailChimp
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do remetente
|
from_name | string |
O padrão do nome das campanhas enviadas para esta lista |
|
Endereço de email do remetente
|
from_email | string |
O padrão de email para campanhas enviadas para esta lista |
|
Assunto
|
subject | string |
A linha de assunto padrão para campanhas enviadas para esta lista |
|
Linguagem
|
language | string |
O idioma padrão dos formulários desta lista |
CreateNewListResponseModel
Criar um novo modelo de resultado de lista
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da lista
|
id | string |
Uma cadeia de caracteres que identifica exclusivamente esta lista |
|
Nome da Lista
|
name | string |
O nome da lista |
|
contato
|
contact | Contact |
Opções de acompanhamento de cápsulas para uma campanha. Deve estar usando a integração interna da Cápsula do MailChimp |
|
Lembrete de permissão
|
permission_reminder | string |
O lembrete de permissão para a lista |
|
Usar a Barra de Arquivos
|
use_archive_bar | boolean |
Se as campanhas para esta lista usam a Barra de Arquivos em arquivos por padrão |
|
campaign_defaults
|
campaign_defaults | Campaign_Defaults |
Opções de acompanhamento de cápsulas para uma campanha. Deve estar usando a integração interna da Cápsula do MailChimp |
|
Notificar sobre a assinatura
|
notify_on_subscribe | string |
O endereço de email para o qual enviar notificações de assinatura |
|
Notificar sobre cancelar assinatura
|
notify_on_unsubscribe | string |
O endereço de email para o qual enviar notificações de cancelamento de assinatura |
|
Data de Criação
|
date_created | string |
A data e a hora em que essa lista foi criada |
|
Classificação de Lista
|
list_rating | integer |
Uma pontuação de atividade gerada automaticamente para a lista (0-5) |
|
Opção de Tipo de Email
|
email_type_option | boolean |
Se a lista dá suporte a vários formatos para emails. Quando definido como true, os assinantes podem escolher se desejam receber emails HTML ou de texto sem formatação. Quando definido como false, os assinantes receberão emails HTML, com um backup alternativo de texto sem formatação |
|
Assinar a URL Abreviada
|
subscribe_url_short | string |
Nossa versão abreviada de EepURL do formulário de assinatura desta lista |
|
Assinar URL Longa
|
subscribe_url_long | string |
A versão completa do formulário de assinatura desta lista (o host variará) |
|
Endereço do beamer
|
beamer_address | string |
O endereço do Beamer de Email da lista |
|
Visibilidade
|
visibility | string |
Se esta lista é pública ou privada |
|
Módulos
|
modules | array of string |
Todos os módulos específicos da lista instalados para esta lista |
|
estatísticas
|
stats | Stats |
Estatísticas da lista. Muitos deles são armazenados em cache por pelo menos cinco minutos |
|
Links
|
_links | array of Link |
Uma lista de tipos de link e descrições para os documentos de esquema de API |
Estatísticas
Estatísticas da lista. Muitos deles são armazenados em cache por pelo menos cinco minutos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem de Membros
|
member_count | integer |
O número de membros ativos na lista |
|
Cancelar contagem de assinaturas
|
unsubscribe_count | integer |
O número de membros que cancelaram a assinatura da lista |
|
Contagem limpa
|
cleaned_count | integer |
O número de membros limpos da lista |
|
Contagem de membros desde o envio
|
member_count_since_send | integer |
O número de membros ativos na lista desde que a última campanha foi enviada |
|
Cancelar a contagem de assinaturas desde o envio
|
unsubscribe_count_since_send | integer |
O número de membros que cancelaram a assinatura desde que a última campanha foi enviada |
|
Contagem limpa desde o envio
|
cleaned_count_since_send | integer |
O número de membros limpos da lista desde que a última campanha foi enviada |
|
Contagem de campanhas
|
campaign_count | integer |
O número de campanhas em qualquer status que use esta lista |
|
Última mensagem da campanha
|
campaign_last_sent | date-time |
A data e a hora em que a última campanha foi enviada para esta lista |
|
Contagem de Var de Mesclagem
|
merge_field_count | integer |
O número de vars de mesclagem para esta lista (não EMAIL, o que é necessário) |
|
Taxa média de assinatura
|
avg_sub_rate | float |
O número médio de assinaturas por mês para a lista(não retornada se ainda não a calculamos) |
|
Taxa média de não subscrição
|
avg_unsub_rate | float |
O número médio de não inscrições por mês para a lista (não retornado se ainda não a calculamos) |
|
Taxa de Assinatura de Destino
|
target_sub_rate | float |
O número de assinaturas de destino por mês da lista para mantê-la crescendo(não retornada se ainda não a calculamos) |
|
Taxa aberta
|
open_rate | float |
A taxa aberta média (uma porcentagem representada como um número entre 0 e 100) por campanha para a lista(não retornada se ainda não a calculamos) |
|
Clique em Taxa
|
click_rate | float |
A taxa média de cliques (uma porcentagem representada como um número entre 0 e 100) por campanha para a lista(não retornada se ainda não a calculamos) |
|
Data da Assinatura da Última Lista
|
last_sub_date | string |
A data e a hora da última vez que alguém assinou esta lista |
|
Data da Assinatura da Última Lista
|
last_unsub_date | string |
A data e a hora da última vez que alguém cancelou a assinatura desta lista |
GetListsResponseModel
Resposta ao obter listas
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Lists
|
lists | array of CreateNewListResponseModel |
Uma matriz de objetos, cada um representando uma lista |
|
Contagem de Itens
|
total_items | integer |
O número total de itens correspondentes à consulta, independentemente da paginação |
FirstAndLastName
Campos mesclados que contêm nome de usuário e sobrenome
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Primeiro Nome
|
FNAME | string |
Nome do assinante |
|
Apelido
|
LNAME | string |
Sobrenome do assinante |
Localização
Informações de localização do assinante
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Latitude
|
latitude | float |
A latitude do local |
|
Longitude
|
longitude | float |
A longitude do local |
MemberResponseModel
Modelo de resultado do membro
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Email
|
id | string |
O hash MD5 da versão minúscula do endereço de email do membro da lista |
|
Endereço eletrônico
|
email_address | string |
Endereço de email para um assinante |
|
ID de email exclusiva
|
unique_email_id | string |
Um identificador para o endereço em todo o MailChimp |
|
Tipo de email
|
email_type | string |
Tipo de email que este membro pediu para obter ('html' ou 'text'). |
|
Situação
|
status | string |
Status atual do assinante. Valores possíveis: inscrito, não assinado, limpo, pendente |
|
merge_fields
|
merge_fields | FirstAndLastName |
Campos mesclados que contêm nome de usuário e sobrenome |
|
estatísticas
|
stats | Stats |
Estatísticas da lista. Muitos deles são armazenados em cache por pelo menos cinco minutos |
|
IP de inscrição
|
ip_signup | string |
Endereço IP do qual o assinante se inscreveu |
|
Carimbo de data/hora de inscrição
|
timestamp_signup | string |
Data e hora em que o assinante se inscreveu na lista |
|
IP de aceitação
|
ip_opt | string |
O endereço IP usado pelo assinante para confirmar o status de aceitação |
|
Carimbo de data/hora de aceitação
|
timestamp_opt | string |
Data e hora em que a assinatura confirmou seu status de aceitação |
|
Classificação de Membro
|
member_rating | integer |
Classificação de estrela para este membro, entre 1 e 5 |
|
Data da Última Alteração
|
last_changed | string |
Data e hora em que as informações do membro foram alteradas pela última vez |
|
Linguagem
|
language | string |
Se definido/detectado, o idioma do assinante |
|
VIP
|
vip | boolean |
Status VIP para assinante |
|
Cliente de email
|
email_client | string |
O cliente de email do membro da lista |
|
local
|
location | Location |
Informações de localização do assinante |
|
last_note
|
last_note | Last_Note |
Nota mais recente adicionada sobre este membro |
|
ID da lista
|
list_id | string |
A ID da lista |
|
Links
|
_links | array of Link |
Uma lista de tipos de link e descrições para os documentos de esquema de API |
Last_Note
Nota mais recente adicionada sobre este membro
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da anotação
|
note_id | integer |
A ID da anotação |
|
Hora de Criação
|
created_at | string |
A data em que a anotação foi criada |
|
Autor
|
created_by | string |
O autor da anotação |
|
Observação
|
note | string |
O conteúdo da anotação |
GetAddMembersBatchResponseModel
Resposta ao assinar ou cancelar a assinatura de membros da lista em um lote
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Total criado
|
total_created | integer |
Número total de membros que foram adicionados à lista |
|
Total atualizado
|
total_updated | integer |
O número total de membros de uma lista existente cujo status de assinatura foi atualizado |
|
Contagem de erros
|
error_count | integer |
O número de endereços de email que não puderam ser adicionados à lista ou atualizados |
GetAllMembersResponseModel
Resposta ao consultar todos os membros em uma lista
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Members
|
members | array of MemberResponseModel |
Uma matriz de objetos, cada um representando um membro de lista específico |
|
ID da lista
|
list_id | string |
A ID da lista |
|
Total de itens
|
total_items | integer |
O número total de itens correspondentes à consulta, independentemente da paginação |
GetMembersResponseModel
Resposta ao obter membros em uma lista
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Members
|
members | array of AddUserResponseModel |
Uma matriz de objetos, cada um representando um membro de lista específico |
AddUserResponseModel
Novo modelo de resultado de campanha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Email
|
id | string |
O hash MD5 da versão minúscula do endereço de email do membro da lista |
|
Endereço eletrônico
|
email_address | string |
Endereço de email para um assinante |
|
ID de email exclusiva
|
unique_email_id | string |
Um identificador para o endereço em todo o MailChimp |
|
Tipo de email
|
email_type | string |
Tipo de email que este membro pediu para obter ('html' ou 'text'). |
|
Situação
|
status | string |
Status atual do assinante. Valores possíveis: inscrito, não assinado, limpo, pendente |
|
merge_fields
|
merge_fields | FirstAndLastName |
Campos mesclados que contêm nome de usuário e sobrenome |
|
estatísticas
|
stats | Stats |
Estatísticas da lista. Muitos deles são armazenados em cache por pelo menos cinco minutos |
|
IP de inscrição
|
ip_signup | string |
Endereço IP do qual o assinante se inscreveu |
|
Carimbo de data/hora de inscrição
|
timestamp_signup | string |
Data e hora em que o assinante se inscreveu na lista |
|
IP de aceitação
|
ip_opt | string |
O endereço IP usado pelo assinante para confirmar o status de aceitação |
|
Carimbo de data/hora de aceitação
|
timestamp_opt | string |
Data e hora em que a assinatura confirmou seu status de aceitação |
|
Classificação de Membro
|
member_rating | integer |
Classificação de estrela para este membro, entre 1 e 5 |
|
Data da Última Alteração
|
last_changed | string |
Data e hora em que as informações do membro foram alteradas pela última vez |
|
Linguagem
|
language | string |
Se definido/detectado, o idioma do assinante |
|
VIP
|
vip | boolean |
Status VIP para assinante |
|
Cliente de email
|
email_client | string |
O cliente de email do membro da lista |
|
local
|
location | Location |
Informações de localização do assinante |
|
last_note
|
last_note | Last_Note |
Nota mais recente adicionada sobre este membro |
|
ID da lista
|
list_id | string |
A ID da lista |
|
Links
|
_links | array of Link |
Uma lista de tipos de link e descrições para os documentos de esquema de API |