MailChimp
MailChimp é um serviço SaaS que permite às empresas gerenciar e automatizar atividades de marketing por e-mail, incluindo o envio de e-mails de marketing, mensagens automatizadas e campanhas direcionadas.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | 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) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , 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 | |
|---|---|
| Editora | Microsoft |
| Sítio Web | https://mailchimp.com/ |
| Política de privacidade | https://mailchimp.com/legal/privacy/ |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar membro à lista |
Adicionar ou atualizar um membro da lista |
| Atualizar informações de membro |
Atualizar informações para um membro específico da lista. |
| Enviar campanha (Pré-visualização) |
Enviar uma campanha existente |
| Inscrever ou cancelar a inscrição de membros da lista |
Inscreva-se ou cancele a inscrição em lote de membros da lista. |
| 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 da campanha (linha de assunto, título, from_name e reply_to) (V2). |
| Nova Campanha [DEPRECATED] |
Esta ação foi preterida. Em vez disso, use Nova Campanha (V2).
|
| Nova lista |
Crie uma nova lista na sua conta MailChimp |
| Obter todas as listas |
Encontre todas as listas para o usuário atual |
| Remover Membro da lista |
Excluir um membro de uma lista. |
Adicionar membro à lista
Adicionar ou atualizar um membro da lista
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O id exclusivo para a lista |
|
Tipo de e-mail
|
email_type | string |
Tipo de e-mail que este membro pediu para receber ('html' ou 'texto') |
|
|
Situação
|
status | True | string |
Status atual do assinante. Valores possíveis: subscrito, não subscrito, limpo, pendente |
|
Nome Próprio
|
FNAME | string |
Nome próprio do assinante |
|
|
Apelido
|
LNAME | string |
Apelido do subscritor |
|
|
Linguagem
|
language | string |
Se definido/detetado, o idioma do assinante |
|
|
VIP
|
vip | boolean |
Estatuto VIP para subscritor |
|
|
Latitude
|
latitude | float |
A latitude da localização |
|
|
Longitude
|
longitude | float |
A longitude da localização |
|
|
Endereço de E-mail
|
email_address | True | string |
Endereço de e-mail de um assinante |
Devoluções
Modelo de Resultado do Membro
- Body
- MemberResponseModel
Atualizar informações de membro
Atualizar informações para um membro específico da lista.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O id exclusivo para a lista |
|
E-mail do membro
|
member_email | True | string |
O endereço de e-mail exclusivo do membro a ser atualizado |
|
Tipo de e-mail
|
email_type | string |
Tipo de e-mail que este membro pediu para receber ('html' ou 'texto') |
|
|
Situação
|
status | True | string |
Status atual do assinante. Valores possíveis: subscrito, não subscrito, limpo, pendente |
|
Nome Próprio
|
FNAME | string |
Nome próprio do assinante |
|
|
Apelido
|
LNAME | string |
Apelido do subscritor |
|
|
Linguagem
|
language | string |
Se definido/detetado, o idioma do assinante |
|
|
VIP
|
vip | boolean |
Estatuto VIP para subscritor |
|
|
Latitude
|
latitude | float |
A latitude da localização |
|
|
Longitude
|
longitude | float |
A longitude da localização |
Devoluções
Modelo de Resultado do Membro
- Body
- MemberResponseModel
Enviar campanha (Pré-visualização)
Enviar uma campanha existente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Campanha
|
campaign_id | True | string |
O id exclusivo para a lista |
Inscrever ou cancelar a inscrição de membros da lista
Inscreva-se ou cancele a inscrição em lote de membros da lista.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O id exclusivo para a lista |
|
Ignorar validação de mesclagem
|
skip_merge_validation | boolean |
Permite que os dados dos membros sejam aceitos sem valores de campo de mesclagem |
|
|
Ignorar verificação duplicada
|
skip_duplicate_check | boolean |
Ignora duplicatas enviadas na solicitação |
|
|
Tipo de e-mail
|
email_type | string |
Tipo de e-mail que este membro pediu para receber ('html' ou 'texto') |
|
|
Situação
|
status | True | string |
Status atual do assinante. Valores possíveis: subscrito, não subscrito, limpo, pendente |
|
Nome Próprio
|
FNAME | string |
Nome próprio do assinante |
|
|
Apelido
|
LNAME | string |
Apelido do subscritor |
|
|
Linguagem
|
language | string |
Se definido/detetado, o idioma do assinante |
|
|
VIP
|
vip | boolean |
Estatuto VIP para subscritor |
|
|
Latitude
|
latitude | float |
A latitude da localização |
|
|
Longitude
|
longitude | float |
A longitude da localização |
|
|
Endereço de E-mail
|
email_address | True | string |
Endereço de e-mail de um assinante |
|
Atualizar membros existentes
|
update_existing | boolean |
Se essa operação em lote alterará o status da assinatura dos membros existentes. |
Devoluções
Resposta ao inscrever ou cancelar a inscrição de membros da lista em um lote
Listar campanhas
Esta operação recupera uma lista de campanhas em uma conta
Devoluções
| Name | 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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O id exclusivo para a lista |
|
Resultados Máximos
|
count | integer |
O número de registos a devolver. O valor padrão é 10. O valor máximo é 1000 |
|
|
Compensação
|
offset | integer |
O número de registros de uma coleção a serem ignorados. O valor padrão é 0. |
Devoluções
Resposta ao consultar 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 da campanha (linha de assunto, título, from_name e reply_to) (V2).
Parâmetros
| Name | Chave | Necessá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 campanhas variadas devem ser usadas em vez disso. Valores possíveis: regular, plaintext, absplit, rss, variate |
|
ID da lista
|
list_id | True | string |
O ID da 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 |
|
|
Do nome
|
from_name | True | string |
O nome "de" na campanha (não um endereço de e-mail) |
|
Responder ao endereço
|
reply_to | True | string |
O endereço de e-mail de resposta da campanha |
|
Conversa
|
use_conversation | boolean |
Use o recurso Conversa do MailChimp para gerenciar respostas fora do escritório |
|
|
Para nomear
|
to_name | string |
O nome "Para" personalizado da campanha. Normalmente, o 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. O padrão é true |
|
|
Rodapé automático
|
auto_footer | boolean |
Anexar automaticamente o rodapé padrão do MailChimp à campanha |
|
|
CSS em linha
|
inline_css | boolean |
Inserir automaticamente o CSS incluído no conteúdo da campanha |
|
|
Auto-Tweet
|
auto_tweet | boolean |
Tweetar automaticamente um link para a página de arquivo da campanha quando a campanha é enviada |
|
|
Auto Post no Facebook
|
auto_fb_post | array of integer |
Uma matriz de IDs de página do Facebook para publicação automática em |
|
|
Comentários no Facebook
|
fb_comments | boolean |
Permite comentários do Facebook sobre a campanha (também força a barra de ferramentas Arquivo da campanha). O padrão é true |
|
|
Critérios vencedores
|
winner_criteria | string |
A combinação que tem o melhor desempenho. Isso pode ser determinado automaticamente pela taxa de cliques, taxa de abertura ou receita total, ou você pode escolher manualmente com base nos dados de relatório que achar mais valiosos. Para send_time de teste de Campanhas Multivariadas, winner_critera é ignorado. Para Campanhas Multivariadas com 'manual' como winner_citeria, o vencedor deve ser escolhido na aplicação web MailChimp |
|
|
Tempo de espera
|
wait_time | integer |
O número de minutos de espera antes de escolher a campanha vencedora. O valor de wait_time deve ser superior a 0 e em horas inteiras, especificadas em minutos |
|
|
Tamanho do teste
|
test_size | integer |
A percentagem de destinatários para os quais enviar as combinações de teste deve ter um valor entre 10 e 100 |
|
|
Linhas de assunto
|
subject_lines | array of string |
As possíveis linhas de assunto a testar. Se não forem fornecidas linhas de assunto, settings.subject_line serão utilizadas |
|
|
Horários de envio
|
send_times | array of string |
Os possíveis tempos de envio para teste. Os horários indicados devem ser no formato AAAA-MM-DD HH:MM:SS. Se send_times forem fornecidos para teste, o test_size será definido como 100% e winner_criteria será ignorado |
|
|
Dos nomes
|
from_names | array of string |
O possível a partir de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se não forem fornecidos from_names, settings.from_name serão utilizados |
|
|
Responder a endereços
|
reply_to_addresses | array of string |
O possível a partir de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se não forem fornecidos from_names, settings.from_name serão utilizados |
|
|
Aberturas
|
opens | boolean |
Se as aberturas devem ser rastreadas. O valor padrão é verdadeiro. Não pode ser definido como false para campanhas variadas |
|
|
Rastreamento de cliques em HTML
|
html_clicks | boolean |
Se os cliques devem ser rastreados na versão HTML da campanha. O valor padrão é verdadeiro. Não pode ser definido como false para campanhas variadas |
|
|
Plain-Text Rastreamento de cliques
|
text_clicks | boolean |
Se os cliques devem ser rastreados na versão de texto simples da campanha. O valor padrão é verdadeiro. Não pode ser definido como false para campanhas variadas |
|
|
Rastreamento de metas do MailChimp
|
goal_tracking | boolean |
Se o acompanhamento de metas deve ser ativado |
|
|
Rastreamento eCommerce360
|
ecomm360 | boolean |
Se o rastreamento eCommerce360 deve ser ativado |
|
|
Acompanhamento do Google Analytics
|
google_analytics | string |
O slug personalizado para acompanhamento do Google Analytics (máximo de 50 bytes) |
|
|
Acompanhamento do ClickTale Analytics
|
clicktale | string |
O slug personalizado para rastreamento ClickTale (máximo de 50 bytes) |
|
|
Campanha Salesforce
|
campaign | boolean |
Criar uma campanha em uma conta do Salesforce conectada |
|
|
Nota do Salesforce
|
notes | boolean |
Atualizar as notas de contacto de uma campanha com base nos endereços de e-mail dos subscritores |
|
|
Campanha Highrise
|
campaign | boolean |
Criar uma campanha em uma conta Highrise conectada |
|
|
Nota Highrise
|
notes | boolean |
Atualizar as notas de contacto de uma campanha com base nos endereços de e-mail dos subscritores |
|
|
Nota da cápsula
|
notes | boolean |
Atualizar as notas de contacto de uma campanha com base nos endereços de e-mail dos subscritores |
|
|
Feed URL
|
feed_url | string |
O URL do feed RSS |
|
|
Frequência
|
frequency | string |
A frequência da Campanha RSS |
|
|
Restringir imagens RSS
|
constrain_rss_img | string |
Adicionar CSS a imagens no feed RSS para restringir sua largura em campanhas |
|
|
Hora de envio
|
hour | integer |
A hora de enviar a campanha no horário local. As horas aceitáveis são 0-23. Por exemplo, '4' seria 4h no fuso horário padrão da sua conta |
|
|
Domingo
|
sunday | boolean |
Envia a campanha RSS diária aos domingos |
|
|
Segunda-feira
|
monday | boolean |
Envia a campanha RSS diária às segundas-feiras |
|
|
Terça-feira
|
tuesday | boolean |
Envia diariamente a Campanha RSS às terças-feiras |
|
|
Quarta-feira
|
wednesday | boolean |
Envia diariamente a Campanha RSS às quartas-feiras |
|
|
Quinta-feira
|
thursday | boolean |
Envia a campanha RSS diária às quintas-feiras |
|
|
Sexta-feira
|
friday | boolean |
Envia a campanha RSS diária às sextas-feiras |
|
|
Sábado
|
saturday | boolean |
Envia a campanha RSS diária aos sábados |
|
|
Dia de Envio Semanal
|
weekly_send_day | string |
O dia da semana para enviar uma campanha RSS semanal |
|
|
Dia de envio mensal
|
monthly_send_date | float |
O dia do mês para enviar uma campanha RSS mensal. Os dias aceitáveis são de 1 a 32, em que '0' é sempre o último dia de um mês. Meses com menos do que o número de dias selecionado não terão uma campanha RSS enviada nesse dia. Por exemplo, as Campanhas RSS programadas para serem enviadas no dia 30 não sairão em fevereiro |
|
|
URL da imagem
|
image_url | string |
O url da imagem do cabeçalho do cartão |
|
|
Descrição da Campanha
|
description | string |
Um breve resumo da campanha a apresentar |
|
|
Title
|
title | string |
O título do cartão. Normalmente, a linha de assunto da campanha |
Devoluções
Novo modelo de resultado da campanha
Nova Campanha [DEPRECATED]
Esta ação foi preterida. Em vez disso, use Nova Campanha (V2).
Crie uma nova campanha com base em um Tipo de campanha, lista de destinatários e Configurações da campanha (linha de assunto, título, from_name e reply_to)
Parâmetros
| Name | Chave | Necessá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 campanhas variadas devem ser usadas em vez disso. Valores possíveis: regular, plaintext, absplit, rss, variate |
|
ID da lista
|
list_id | True | string |
O ID da 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 |
|
|
Do nome
|
from_name | True | string |
O nome "de" na campanha (não um endereço de e-mail) |
|
Responder ao endereço
|
reply_to | True | string |
O endereço de e-mail de resposta da campanha |
|
Conversa
|
use_conversation | boolean |
Use o recurso Conversa do MailChimp para gerenciar respostas fora do escritório |
|
|
Para nomear
|
to_name | string |
O nome "Para" personalizado da campanha. Normalmente, o 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. O padrão é true |
|
|
Rodapé automático
|
auto_footer | boolean |
Anexar automaticamente o rodapé padrão do MailChimp à campanha |
|
|
CSS em linha
|
inline_css | boolean |
Inserir automaticamente o CSS incluído no conteúdo da campanha |
|
|
Auto-Tweet
|
auto_tweet | boolean |
Tweetar automaticamente um link para a página de arquivo da campanha quando a campanha é enviada |
|
|
Auto Post no Facebook
|
auto_fb_post | array of integer |
Uma matriz de IDs de página do Facebook para publicação automática em |
|
|
Comentários no Facebook
|
fb_comments | boolean |
Permite comentários do Facebook sobre a campanha (também força a barra de ferramentas Arquivo da campanha). O padrão é true |
|
|
Critérios vencedores
|
winner_criteria | string |
A combinação que tem o melhor desempenho. Isso pode ser determinado automaticamente pela taxa de cliques, taxa de abertura ou receita total, ou você pode escolher manualmente com base nos dados de relatório que achar mais valiosos. Para send_time de teste de Campanhas Multivariadas, winner_critera é ignorado. Para Campanhas Multivariadas com 'manual' como winner_citeria, o vencedor deve ser escolhido na aplicação web MailChimp |
|
|
Tempo de espera
|
wait_time | integer |
O número de minutos de espera antes de escolher a campanha vencedora. O valor de wait_time deve ser superior a 0 e em horas inteiras, especificadas em minutos |
|
|
Tamanho do teste
|
test_size | integer |
A percentagem de destinatários para os quais enviar as combinações de teste deve ter um valor entre 10 e 100 |
|
|
Linhas de assunto
|
subject_lines | array of string |
As possíveis linhas de assunto a testar. Se não forem fornecidas linhas de assunto, settings.subject_line serão utilizadas |
|
|
Horários de envio
|
send_times | array of string |
Os possíveis tempos de envio para teste. Os horários indicados devem ser no formato AAAA-MM-DD HH:MM:SS. Se send_times forem fornecidos para teste, o test_size será definido como 100% e winner_criteria será ignorado |
|
|
Dos nomes
|
from_names | array of string |
O possível a partir de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se não forem fornecidos from_names, settings.from_name serão utilizados |
|
|
Responder a endereços
|
reply_to_addresses | array of string |
O possível a partir de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se não forem fornecidos from_names, settings.from_name serão utilizados |
|
|
Aberturas
|
opens | boolean |
Se as aberturas devem ser rastreadas. O valor padrão é verdadeiro. Não pode ser definido como false para campanhas variadas |
|
|
Rastreamento de cliques em HTML
|
html_clicks | boolean |
Se os cliques devem ser rastreados na versão HTML da campanha. O valor padrão é verdadeiro. Não pode ser definido como false para campanhas variadas |
|
|
Plain-Text Rastreamento de cliques
|
text_clicks | boolean |
Se os cliques devem ser rastreados na versão de texto simples da campanha. O valor padrão é verdadeiro. Não pode ser definido como false para campanhas variadas |
|
|
Rastreamento de metas do MailChimp
|
goal_tracking | boolean |
Se o acompanhamento de metas deve ser ativado |
|
|
Rastreamento eCommerce360
|
ecomm360 | boolean |
Se o rastreamento eCommerce360 deve ser ativado |
|
|
Acompanhamento do Google Analytics
|
google_analytics | string |
O slug personalizado para acompanhamento do Google Analytics (máximo de 50 bytes) |
|
|
Acompanhamento do ClickTale Analytics
|
clicktale | string |
O slug personalizado para rastreamento ClickTale (máximo de 50 bytes) |
|
|
Campanha Salesforce
|
campaign | boolean |
Criar uma campanha em uma conta do Salesforce conectada |
|
|
Nota do Salesforce
|
notes | boolean |
Atualizar as notas de contacto de uma campanha com base nos endereços de e-mail dos subscritores |
|
|
Campanha Highrise
|
campaign | boolean |
Criar uma campanha em uma conta Highrise conectada |
|
|
Nota Highrise
|
notes | boolean |
Atualizar as notas de contacto de uma campanha com base nos endereços de e-mail dos subscritores |
|
|
Nota da cápsula
|
notes | boolean |
Atualizar as notas de contacto de uma campanha com base nos endereços de e-mail dos subscritores |
|
|
Feed URL
|
feed_url | string |
O URL do feed RSS |
|
|
Frequência
|
frequency | string |
A frequência da Campanha RSS |
|
|
Restringir imagens RSS
|
constrain_rss_img | string |
Adicionar CSS a imagens no feed RSS para restringir sua largura em campanhas |
|
|
Hora de envio
|
hour | integer |
A hora de enviar a campanha no horário local. As horas aceitáveis são 0-23. Por exemplo, '4' seria 4h no fuso horário padrão da sua conta |
|
|
Domingo
|
sunday | boolean |
Envia a campanha RSS diária aos domingos |
|
|
Segunda-feira
|
monday | boolean |
Envia a campanha RSS diária às segundas-feiras |
|
|
Terça-feira
|
tuesday | boolean |
Envia diariamente a Campanha RSS às terças-feiras |
|
|
Quarta-feira
|
wednesday | boolean |
Envia diariamente a Campanha RSS às quartas-feiras |
|
|
Quinta-feira
|
thursday | boolean |
Envia a campanha RSS diária às quintas-feiras |
|
|
Sexta-feira
|
friday | boolean |
Envia a campanha RSS diária às sextas-feiras |
|
|
Sábado
|
saturday | boolean |
Envia a campanha RSS diária aos sábados |
|
|
Dia de Envio Semanal
|
weekly_send_day | string |
O dia da semana para enviar uma campanha RSS semanal |
|
|
Dia de envio mensal
|
monthly_send_date | float |
O dia do mês para enviar uma campanha RSS mensal. Os dias aceitáveis são de 1 a 32, em que '0' é sempre o último dia de um mês. Meses com menos do que o número de dias selecionado não terão uma campanha RSS enviada nesse dia. Por exemplo, as Campanhas RSS programadas para serem enviadas no dia 30 não sairão em fevereiro |
|
|
URL da imagem
|
image_url | string |
O url da imagem do cabeçalho do cartão |
|
|
Descrição da Campanha
|
description | string |
Um breve resumo da campanha a apresentar |
|
|
Title
|
title | string |
O título do cartão. Normalmente, a linha de assunto da campanha |
Devoluções
Novo modelo de resultado da campanha
Nova lista
Crie uma nova lista na sua conta MailChimp
Parâmetros
| Name | Chave | Necessá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 do contato da lista |
|
Endereço Linha 2
|
address2 | string |
O endereço do contato da lista |
|
|
City
|
city | True | string |
A cidade para o contato da lista |
|
Estado
|
state | True | string |
O estado do contato da lista |
|
Código Postal
|
zip | True | string |
O código postal ou postal do contacto da lista |
|
Código do país
|
country | True | string |
Um código de país ISO3166 dois caracteres. O padrão é US se for 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 de como elas se inscreveram nesta lista |
|
Usar a Barra de Arquivo
|
use_archive_bar | boolean |
Se as campanhas para esta lista usam a Barra de Arquivo em arquivos por padrão |
|
|
Nome do remetente
|
from_name | True | string |
O nome padrão das campanhas enviadas para esta lista |
|
Endereço de e-mail do remetente
|
from_email | True | string |
O padrão do e-mail 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 para os formulários desta lista |
|
Notificar em Subscrever
|
notify_on_subscribe | string |
O endereço de e-mail para o qual enviar notificações de subscrição |
|
|
Notificar ao cancelar inscrição
|
notify_on_unsubscribe | string |
O endereço de e-mail para o qual enviar notificações de cancelamento de inscrição |
|
|
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 e-mails HTML ou de texto simples. Quando definido como false, os assinantes receberão e-mails HTML, com um backup alternativo de texto simples |
|
Visibilidade
|
visibility | string |
Se esta lista é pública ou privada |
Devoluções
Criar novo modelo de resultado de lista
Obter todas as listas
Encontre todas as listas para o usuário atual
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Resultados Máximos
|
count | integer |
O número de registos a devolver. O valor padrão é 10. O valor máximo é 1000 |
|
|
Compensação
|
offset | integer |
O número de registros de uma coleção a serem ignorados. O valor padrão é 0. |
Devoluções
Resposta ao obter listas
Remover Membro da lista
Excluir um membro de uma lista.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O id exclusivo para a lista |
|
E-mail do membro
|
member_email | True | string |
O endereço de e-mail do membro a excluir |
Acionadores
| Quando um Membro foi adicionado a uma lista |
Aciona um fluxo de trabalho quando um novo membro é adicionado a uma lista |
| Quando uma nova lista é criada |
Aciona um fluxo de trabalho quando uma nova lista é criada |
Quando um Membro foi adicionado a uma lista
Aciona um fluxo de trabalho quando um novo membro é adicionado a uma lista
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O id exclusivo para a lista |
Devoluções
Resposta ao colocar membros em uma lista
Quando uma nova lista é criada
Aciona um fluxo de trabalho quando uma nova lista é criada
Devoluções
Resposta ao obter listas
Definições
Recipient
Configurações da campanha
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da lista
|
list_id | string |
O ID da 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
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Critérios vencedores
|
winner_criteria | string |
A combinação que tem o melhor desempenho. Isso pode ser determinado automaticamente pela taxa de cliques, taxa de abertura ou receita total, ou você pode escolher manualmente com base nos dados de relatório que achar mais valiosos. Para send_time de teste de Campanhas Multivariadas, winner_critera é ignorado. Para Campanhas Multivariadas com 'manual' como winner_citeria, o vencedor deve ser escolhido na aplicação web MailChimp |
|
Tempo de espera
|
wait_time | integer |
O número de minutos de espera antes de escolher a campanha vencedora. O valor de wait_time deve ser superior a 0 e em horas inteiras, especificadas em minutos |
|
Tamanho do teste
|
test_size | integer |
A percentagem de destinatários para os quais enviar as combinações de teste deve ter um valor entre 10 e 100 |
|
Linhas de assunto
|
subject_lines | array of string |
As possíveis linhas de assunto a testar. Se não forem fornecidas linhas de assunto, settings.subject_line serão utilizadas |
|
Horários de envio
|
send_times | array of string |
Os possíveis tempos de envio para teste. Os horários indicados devem ser no formato AAAA-MM-DD HH:MM:SS. Se send_times forem fornecidos para teste, o test_size será definido como 100% e winner_criteria será ignorado |
|
Dos nomes
|
from_names | array of string |
O possível a partir de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se não forem fornecidos from_names, settings.from_name serão utilizados |
|
Responder a endereços
|
reply_to_addresses | array of string |
O possível a partir de nomes. O número de from_names fornecidos deve corresponder ao número de reply_to_addresses. Se não forem fornecidos from_names, settings.from_name serão utilizados |
Monitorização
Configurações da campanha
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Aberturas
|
opens | boolean |
Se as aberturas devem ser rastreadas. O valor padrão é verdadeiro. Não pode ser definido como false para campanhas variadas |
|
Rastreamento de cliques em HTML
|
html_clicks | boolean |
Se os cliques devem ser rastreados na versão HTML da campanha. O valor padrão é verdadeiro. Não pode ser definido como false para campanhas variadas |
|
Plain-Text Rastreamento de cliques
|
text_clicks | boolean |
Se os cliques devem ser rastreados na versão de texto simples da campanha. O valor padrão é verdadeiro. Não pode ser definido como false para campanhas variadas |
|
Rastreamento de metas do MailChimp
|
goal_tracking | boolean |
Se o acompanhamento de metas deve ser ativado |
|
Rastreamento eCommerce360
|
ecomm360 | boolean |
Se o rastreamento eCommerce360 deve ser ativado |
|
Acompanhamento do Google Analytics
|
google_analytics | string |
O slug personalizado para acompanhamento do Google Analytics (máximo de 50 bytes) |
|
Acompanhamento do ClickTale Analytics
|
clicktale | string |
O slug personalizado para rastreamento ClickTale (máximo de 50 bytes) |
|
Salesforce
|
salesforce | Salesforce |
Opções de acompanhamento do Salesforce para uma campanha. Deve estar usando a integração integrada do MailChimp com o Salesforce |
|
arranha-céus
|
highrise | Highrise |
Opções de acompanhamento de arranha-céus para uma campanha. Deve estar usando a integração Highrise integrada do MailChimp |
|
cápsula
|
capsule | Capsule |
Opções de rastreamento de cápsulas para uma campanha. Deve estar usando a integração de cápsula integrada do MailChimp |
RSS_Opts
Opções RSS para uma campanha
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Feed URL
|
feed_url | string |
O URL do feed RSS |
|
Frequência
|
frequency | string |
A frequência da Campanha RSS |
|
Restringir imagens RSS
|
constrain_rss_img | string |
Adicionar CSS a imagens no feed RSS para restringir sua largura em campanhas |
|
cronograma
|
schedule | Schedule |
O calendário para o envio da Campanha RSS |
Social_Card
Configurações da campanha
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URL da imagem
|
image_url | string |
O url da imagem do cabeçalho do cartão |
|
Descrição da Campanha
|
description | string |
Um breve resumo da campanha a apresentar |
|
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
| Name | 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 integrada do MailChimp com o Salesforce
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Campanha Salesforce
|
campaign | boolean |
Criar uma campanha em uma conta do Salesforce conectada |
|
Nota do Salesforce
|
notes | boolean |
Atualizar as notas de contacto de uma campanha com base nos endereços de e-mail dos subscritores |
Highrise
Opções de acompanhamento de arranha-céus para uma campanha. Deve estar usando a integração Highrise integrada do MailChimp
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Campanha Highrise
|
campaign | boolean |
Criar uma campanha em uma conta Highrise conectada |
|
Nota Highrise
|
notes | boolean |
Atualizar as notas de contacto de uma campanha com base nos endereços de e-mail dos subscritores |
Cápsula
Opções de rastreamento de cápsulas para uma campanha. Deve estar usando a integração de cápsula integrada do MailChimp
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nota da cápsula
|
notes | boolean |
Atualizar as notas de contacto de uma campanha com base nos endereços de e-mail dos subscritores |
Schedule
O calendário para o envio da Campanha RSS
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Hora de envio
|
hour | integer |
A hora de enviar a campanha no horário local. As horas aceitáveis são 0-23. Por exemplo, '4' seria 4h no fuso horário padrão da sua conta |
|
daily_send
|
daily_send | Daily_Send |
Os dias da semana para enviar uma campanha RSS diária. |
|
Dia de Envio Semanal
|
weekly_send_day | string |
O dia da semana para enviar uma campanha RSS semanal |
|
Dia de envio mensal
|
monthly_send_date | float |
O dia do mês para enviar uma campanha RSS mensal. Os dias aceitáveis são de 1 a 32, em que '0' é sempre o último dia de um mês. Meses com menos do que o número de dias selecionado não terão uma campanha RSS enviada nesse dia. Por exemplo, as Campanhas RSS programadas para serem enviadas no dia 30 não sairão em fevereiro |
Daily_Send
Os dias da semana para enviar uma campanha RSS diária.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Domingo
|
sunday | boolean |
Envia a campanha RSS diária aos domingos |
|
Segunda-feira
|
monday | boolean |
Envia a campanha RSS diária às segundas-feiras |
|
Terça-feira
|
tuesday | boolean |
Envia diariamente a Campanha RSS às terças-feiras |
|
Quarta-feira
|
wednesday | boolean |
Envia diariamente a Campanha RSS às quartas-feiras |
|
Quinta-feira
|
thursday | boolean |
Envia a campanha RSS diária às quintas-feiras |
|
Sexta-feira
|
friday | boolean |
Envia a campanha RSS diária às sextas-feiras |
|
Sábado
|
saturday | boolean |
Envia a campanha RSS diária aos sábados |
Modelo de Resposta da Campanha
Novo modelo de resultado da campanha
| Name | 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 campanhas variadas devem ser usadas em vez disso |
|
Tempo de Criação
|
create_time | string |
Data e hora em que a campanha foi criada |
|
URL do arquivo
|
archive_url | string |
A ligação para a versão de arquivo da campanha |
|
Situação
|
status | string |
A ligação para a versão de arquivo da campanha |
|
E-mails enviados
|
emails_sent | integer |
O número total de e-mails enviados para esta campanha |
|
Hora de envio
|
send_time | string |
A hora e a data em que uma campanha foi enviada |
|
Tipo de conteúdo
|
content_type | string |
Como é montado o conteúdo da campanha ('template', 'drag_and_drop', 'html', 'url') |
|
List
|
recipient | array of Recipient |
Listar configurações para a campanha |
|
definições
|
settings | SettingsV2 |
Configurações da campanha |
|
variate_settings
|
variate_settings | Variate_Settings |
Configurações da campanha |
|
controlo
|
tracking | Tracking |
Configurações da campanha |
|
rss_opts
|
rss_opts | RSS_Opts |
Opções 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 cancelamentos de inscrição |
|
delivery_status
|
delivery_status | Delivery_Status |
Atualizações sobre campanhas em processo de envio |
|
_links
|
_links | array of Link |
Uma lista de tipos de link e descrições para os documentos de esquema da API |
ConfiguraçõesV2
Configurações da campanha
| Name | 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 |
|
Do nome
|
from_name | string |
O nome "de" na campanha (não um endereço de e-mail) |
|
Responder ao endereço
|
reply_to | string |
O endereço de e-mail de resposta da campanha |
|
Conversa
|
use_conversation | boolean |
Use o recurso Conversa do MailChimp para gerenciar respostas fora do escritório |
|
Para nomear
|
to_name | string |
O nome "Para" personalizado da campanha. Normalmente, o 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. O padrão é true |
|
Rodapé automático
|
auto_footer | boolean |
Anexar automaticamente o rodapé padrão do MailChimp à campanha |
|
CSS em linha
|
inline_css | boolean |
Inserir automaticamente o CSS incluído no conteúdo da campanha |
|
Auto-Tweet
|
auto_tweet | boolean |
Tweetar automaticamente um link para a página de arquivo da campanha quando a campanha é enviada |
|
Auto Post no Facebook
|
auto_fb_post | array of integer |
Uma matriz de IDs de página do Facebook para publicação automática em |
|
Comentários no Facebook
|
fb_comments | boolean |
Permite comentários do Facebook sobre a campanha (também força a barra de ferramentas Arquivo da campanha). O padrão é true |
AB_Split_Opts
Opções de teste A/B para uma campanha
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Teste de divisão
|
split_test | string |
O tipo de divisão AB a ser executado |
|
Escolha o vencedor
|
pick_winner | string |
Como devemos avaliar um vencedor. Com base em 'abre', 'cliques' 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 após o envio de uma campanha |
|
Tempo de espera
|
wait_time | integer |
A quantidade de tempo de espera antes de escolher um vencedor. Isso não pode ser alterado após o envio de uma campanha |
|
Tamanho dividido
|
split_size | integer |
O tamanho dos grupos divididos. As campanhas divididas com base no "calendário" são forçadas a ter uma divisão de 50/50. Os inteiros divididos válidos estão entre 1-50 |
|
Do Nome Grupo A
|
from_name_a | string |
Para campanhas divididas em 'Do nome', o nome do Grupo A |
|
Do Nome Grupo B
|
from_name_b | string |
Para campanhas divididas em 'Do nome', o nome do Grupo B |
|
Responder Email Grupo A
|
reply_email_a | string |
Para campanhas divididas em "Do nome", o endereço de resposta para o Grupo A |
|
Responder Email Grupo B
|
reply_email_b | string |
Para campanhas divididas em "Do nome", o endereço de resposta para o Grupo B |
|
Linha de assunto Grupo A
|
subject_a | string |
Para campanhas divididas em "Linha de assunto", a linha de assunto do Grupo A |
|
Linha de assunto Grupo B
|
subject_b | string |
Para campanhas divididas em "Linha de assunto", a linha de assunto para o Grupo B |
|
Enviar Grupo de Tempo A
|
send_time_a | string |
O tempo de envio para o Grupo A |
|
Enviar Grupo de Tempo B
|
send_time_b | string |
O tempo de envio para o Grupo B |
|
Enviar Vencedor do Tempo
|
send_time_winner | string |
O tempo de envio para a versão vencedora |
Report_Summary
Para campanhas enviadas, um resumo de aberturas, cliques e cancelamentos de inscrição
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Automação Abre
|
opens | integer |
O número total de aberturas para uma campanha |
|
Unique Abre
|
unique_opens | integer |
O número de aberturas exclusivas |
|
Taxa de Abertura
|
open_rate | float |
O número de aberturas únicas dividido pelo número total de entregas bem-sucedidas |
|
Total de cliques
|
clicks | integer |
O número total de cliques de uma campanha |
|
Cliques exclusivos do assinante
|
subscriber_clicks | float |
O número de cliques únicos |
|
Taxa de cliques
|
click_rate | float |
O número de cliques únicos dividido pelo número total de entregas bem-sucedidas |
Delivery_Status
Atualizações sobre campanhas em processo de envio
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Staut de entrega ativado
|
enabled | boolean |
Se o Status de Entrega da Campanha está habilitado para esta conta e campanha |
|
Campanha cancelável
|
can_cancel | boolean |
Se o envio de uma campanha pode ser cancelado |
|
Status de entrega da campanha
|
status | string |
O estado atual de uma entrega de campanha |
|
E-mails enviados
|
emails_sent | integer |
O número total de e-mails confirmados enviados para esta campanha até agora |
|
E-mails cancelados
|
emails_canceled | integer |
O número total de e-mails cancelados para esta campanha |
Link
Opções de rastreamento de cápsulas para uma campanha. Deve estar usando a integração de cápsula integrada do MailChimp
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Rel
|
rel | string |
Tal como acontece com um atributo HTML 'rel', isto descreve o tipo de ligação |
|
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'. (OBTER, POSTAR, COLOCAR, CORRIGIR, EXCLUIR, OPÇÕES, CABEÇA) |
|
Esquema de destino
|
targetSchema | string |
Para GETs, esta é 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), esta é uma URL que representa o esquema ao qual o corpo deve estar em conformidade |
Contato
Opções de rastreamento de cápsulas para uma campanha. Deve estar usando a integração de cápsula integrada do MailChimp
| Name | 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 do contato da lista |
|
Endereço Linha 2
|
address2 | string |
O endereço do contato da lista |
|
City
|
city | string |
A cidade para o contato da lista |
|
Estado
|
state | string |
O estado do contato da lista |
|
Código Postal
|
zip | string |
O código postal ou postal do contacto da lista |
|
Código do país
|
country | string |
Um código de país ISO3166 dois caracteres. O padrão é US se for inválido |
|
Número de Telefone
|
phone | string |
O número de telefone do contato da lista |
Campaign_Defaults
Opções de rastreamento de cápsulas para uma campanha. Deve estar usando a integração de cápsula integrada do MailChimp
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do remetente
|
from_name | string |
O nome padrão das campanhas enviadas para esta lista |
|
Endereço de e-mail do remetente
|
from_email | string |
O padrão do e-mail 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 para os formulários desta lista |
CreateNewListResponseModel
Criar novo modelo de resultado de lista
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da lista
|
id | string |
Uma cadeia de caracteres que identifica exclusivamente essa lista |
|
Nome da lista
|
name | string |
O nome da lista |
|
contacto
|
contact | Contact |
Opções de rastreamento de cápsulas para uma campanha. Deve estar usando a integração de cápsula integrada do MailChimp |
|
Lembrete de permissão
|
permission_reminder | string |
O lembrete de permissão para a lista |
|
Usar a Barra de Arquivo
|
use_archive_bar | boolean |
Se as campanhas para esta lista usam a Barra de Arquivo em arquivos por padrão |
|
campaign_defaults
|
campaign_defaults | Campaign_Defaults |
Opções de rastreamento de cápsulas para uma campanha. Deve estar usando a integração de cápsula integrada do MailChimp |
|
Notificar em Subscrever
|
notify_on_subscribe | string |
O endereço de e-mail para o qual enviar notificações de subscrição |
|
Notificar ao cancelar inscrição
|
notify_on_unsubscribe | string |
O endereço de e-mail para o qual enviar notificações de cancelamento de inscrição |
|
Data de criação
|
date_created | string |
A data e a hora em que esta lista foi criada |
|
Classificação da lista
|
list_rating | integer |
Uma pontuação de atividade gerada automaticamente para a lista (0-5) |
|
Opção de tipo de e-mail
|
email_type_option | boolean |
Se a lista suporta vários formatos para e-mails. Quando definido como true, os assinantes podem escolher se desejam receber e-mails HTML ou de texto simples. Quando definido como false, os assinantes receberão e-mails HTML, com um backup alternativo de texto simples |
|
Subscrever URL Curto
|
subscribe_url_short | string |
A nossa versão abreviada EepURL do formulário de subscrição desta lista |
|
Subscrever URL Longo
|
subscribe_url_long | string |
A versão completa do formulário de inscrição desta lista (o anfitrião varia) |
|
Endereço Beamer
|
beamer_address | string |
O endereço Email Beamer da lista |
|
Visibilidade
|
visibility | string |
Se esta lista é pública ou privada |
|
Modules
|
modules | array of string |
Quaisquer módulos específicos da lista instalados para esta lista |
|
estatísticas
|
stats | Stats |
Estatísticas para a 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 da API |
Stats
Estatísticas para a lista. Muitos deles são armazenados em cache por pelo menos cinco minutos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem de Membros
|
member_count | integer |
O número de membros ativos na lista |
|
Contagem de Cancelamento de Inscrição
|
unsubscribe_count | integer |
O número de membros que cancelaram a inscrição na 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 a última campanha foi enviada |
|
Cancelar a contagem de inscrições desde o envio
|
unsubscribe_count_since_send | integer |
O número de membros que cancelaram a inscrição desde a última campanha foi enviado |
|
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 usam essa lista |
|
Última Campanha Enviada
|
campaign_last_sent | date-time |
A data e hora em que a última campanha foi enviada para esta lista |
|
Mesclar contagem de var
|
merge_field_count | integer |
O número de vars de mesclagem para esta lista (não EMAIL, que é necessário) |
|
Taxa média de subscrição
|
avg_sub_rate | float |
O número médio de subscrições por mês para a lista (não devolvido se ainda não a tivermos calculado) |
|
Taxa média de cancelamento de subscrição
|
avg_unsub_rate | float |
O número médio de cancelamentos de assinaturas por mês para a lista (não retornados se ainda não a tivermos calculado) |
|
Taxa de subscrição alvo
|
target_sub_rate | float |
O número alvo de subscrições por mês para a lista continuar a crescer (não devolvido se ainda não a tivermos calculado) |
|
Taxa de Abertura
|
open_rate | float |
A taxa média de abertura (uma percentagem representada como um número entre 0 e 100) por campanha para a lista (não devolvida se ainda não a tivermos calculado) |
|
Taxa de cliques
|
click_rate | float |
A taxa média de cliques (uma percentagem representada como um número entre 0 e 100) por campanha para a lista (não devolvida se ainda não a tivermos calculado) |
|
Data da Última Lista Subscrever
|
last_sub_date | string |
A data e hora da última vez que alguém se inscreveu nesta lista |
|
Data da Última Lista Cancelar inscrição
|
last_unsub_date | string |
A data e a hora da última vez que alguém cancelou a inscrição nesta lista |
GetListsResponseModel
Resposta ao obter listas
| Name | 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 |
PrimeiroAndSobrenome
Campos mesclados contendo Nome e sobrenome do usuário
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome Próprio
|
FNAME | string |
Nome próprio do assinante |
|
Apelido
|
LNAME | string |
Apelido do subscritor |
Localização
Informações de localização do assinante
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Latitude
|
latitude | float |
A latitude da localização |
|
Longitude
|
longitude | float |
A longitude da localização |
MemberResponseModel
Modelo de Resultado do Membro
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de E-mail
|
id | string |
O hash MD5 da versão minúscula do endereço de e-mail do membro da lista |
|
Endereço de E-mail
|
email_address | string |
Endereço de e-mail de um assinante |
|
ID de e-mail exclusivo
|
unique_email_id | string |
Um identificador para o endereço em todo o MailChimp |
|
Tipo de e-mail
|
email_type | string |
Tipo de e-mail que este membro pediu para receber ('html' ou 'texto'). |
|
Situação
|
status | string |
Status atual do assinante. Valores possíveis: subscrito, não subscrito, limpo, pendente |
|
merge_fields
|
merge_fields | FirstAndLastName |
Campos mesclados contendo Nome e sobrenome do usuário |
|
estatísticas
|
stats | Stats |
Estatísticas para a lista. Muitos deles são armazenados em cache por pelo menos cinco minutos |
|
IP de inscrição
|
ip_signup | string |
Endereço IP a partir do qual o subscritor 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 que o subscritor utilizou para confirmar o seu estado de aceitação |
|
Opção de carimbo de data/hora
|
timestamp_opt | string |
Data e hora em que a subscrição confirmou o seu estado de aceitação |
|
Classificação dos Membros
|
member_rating | integer |
Classificação por estrelas 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/detetado, o idioma do assinante |
|
VIP
|
vip | boolean |
Estatuto VIP para subscritor |
|
Cliente de e-mail
|
email_client | string |
O cliente de e-mail do membro da lista |
|
localização
|
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 |
O id da lista |
|
Links
|
_links | array of Link |
Uma lista de tipos de link e descrições para os documentos de esquema da API |
Last_Note
Nota mais recente adicionada sobre este membro
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da nota
|
note_id | integer |
O id da nota |
|
Tempo de Criação
|
created_at | string |
A data em que a nota foi criada |
|
Author
|
created_by | string |
O autor da nota |
|
Observação
|
note | string |
Conteúdo da nota |
GetAddMembersBatchResponseModel
Resposta ao inscrever ou cancelar a inscrição de membros da lista em um lote
| Name | 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 e-mail que não puderam ser adicionados à lista ou atualizados |
GetAllMembersResponseModel
Resposta ao consultar todos os membros de uma lista
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Members
|
members | array of MemberResponseModel |
Uma matriz de objetos, cada um representando um membro específico da lista |
|
ID da lista
|
list_id | string |
O id da lista |
|
Total de Itens
|
total_items | integer |
O número total de itens correspondentes à consulta, independentemente da paginação |
GetMembersResponseModel
Resposta ao colocar membros em uma lista
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Members
|
members | array of AddUserResponseModel |
Uma matriz de objetos, cada um representando um membro específico da lista |
AddUserResponseModel
Novo modelo de resultado da campanha
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de E-mail
|
id | string |
O hash MD5 da versão minúscula do endereço de e-mail do membro da lista |
|
Endereço de E-mail
|
email_address | string |
Endereço de e-mail de um assinante |
|
ID de e-mail exclusivo
|
unique_email_id | string |
Um identificador para o endereço em todo o MailChimp |
|
Tipo de e-mail
|
email_type | string |
Tipo de e-mail que este membro pediu para receber ('html' ou 'texto'). |
|
Situação
|
status | string |
Status atual do assinante. Valores possíveis: subscrito, não subscrito, limpo, pendente |
|
merge_fields
|
merge_fields | FirstAndLastName |
Campos mesclados contendo Nome e sobrenome do usuário |
|
estatísticas
|
stats | Stats |
Estatísticas para a lista. Muitos deles são armazenados em cache por pelo menos cinco minutos |
|
IP de inscrição
|
ip_signup | string |
Endereço IP a partir do qual o subscritor 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 que o subscritor utilizou para confirmar o seu estado de aceitação |
|
Opção de carimbo de data/hora
|
timestamp_opt | string |
Data e hora em que a subscrição confirmou o seu estado de aceitação |
|
Classificação dos Membros
|
member_rating | integer |
Classificação por estrelas 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/detetado, o idioma do assinante |
|
VIP
|
vip | boolean |
Estatuto VIP para subscritor |
|
Cliente de e-mail
|
email_client | string |
O cliente de e-mail do membro da lista |
|
localização
|
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 |
O id da lista |
|
Links
|
_links | array of Link |
Uma lista de tipos de link e descrições para os documentos de esquema da API |