Moosend (Editor Independente) (Versão prévia)
A plataforma de automação de marketing e software de marketing de email final que não interromperá seu banco. Com centenas de modelos de data up-topara escolher, suas campanhas de marketing de email serão vestidas para o sucesso.
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) – 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 Governamental - 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) – 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) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor |
| Site | https://moosend.com/ |
| Política de privacidade | https://www.sitecore.com/trust/privacy-policy |
| Categorias | Marketing |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar assinante |
Adiciona um novo assinante à lista de endereçamento especificada. |
| Adicionar vários assinantes |
Adiciona vários assinantes em uma lista de endereçamento com uma única chamada. |
| Agendar uma campanha |
Atribui uma data e hora agendadas em que a campanha será entregue. |
| Atualizar um assinante |
Atualiza um assinante na lista de endereçamento especificada. |
| Atualizar um campo personalizado |
Atualiza as propriedades de um campo personalizado existente na lista de endereçamento especificada. |
| Atualizar uma campanha de rascunho |
Atualiza as propriedades de uma campanha ab de rascunho existente em sua conta. Campanhas não rascunho não podem ser atualizadas. Ignore (Opção ab divisão de campanha) se você quiser criar uma campanha regular. |
| Atualizar uma lista de endereçamento |
Atualiza as propriedades de uma lista de endereçamento existente. |
| Cancelar assinatura de assinante da lista de endereçamento |
Cancela a assinatura de um assinante da lista de endereçamento especificada. |
| Cancelar assinatura do assinante da conta |
Cancela a assinatura de um assinante da conta. |
| Clonar uma campanha existente |
Cria uma cópia exata de uma campanha existente. A nova campanha é criada como um rascunho. |
| Criar um campo personalizado |
Cria um novo campo personalizado na lista de endereçamento especificada. |
| Criar uma campanha de rascunho |
Cria uma nova campanha de rascunho em sua conta. |
| Criar uma lista de endereçamento |
Cria uma nova lista de endereçamento vazia em sua conta. |
| Desmarcar uma campanha |
Remove uma data e hora previamente definidas de uma campanha, para que ela seja entregue imediatamente se já estiver na fila ou quando enviada. |
| Enviar uma campanha |
Envia uma campanha de rascunho existente para todos os destinatários especificados em sua lista de endereçamento. A campanha é enviada imediatamente. |
| Excluir uma campanha |
Exclui uma campanha de sua conta, rascunho ou até mesmo enviada. |
| Excluir uma lista de endereçamento |
Exclui uma lista de endereçamento da sua conta. |
| Obter assinante por endereço de email |
Pesquisa um assinante com o endereço de email especificado na lista de endereçamento especificada. |
| Obter assinante por ID |
Pesquisa um assinante com o identificador exclusivo especificado na lista de endereçamento especificada. |
| Obter assinantes |
Recupera uma lista de todos os assinantes em uma determinada lista de endereçamento. |
| Obter atividade de link |
Retorna uma lista com seus links de campanha e quantos cliques foram feitos por seus destinatários, sejam exclusivos ou totais. |
| Obter atividade por local |
Retorna um relatório detalhado de sua campanha aberto (exclusivo e total) por país. |
| Obter campanhas |
Retorna uma lista de todas as campanhas em sua conta com informações detalhadas. |
| Obter detalhes da campanha |
Retorna um conjunto completo de propriedades que descrevem a campanha solicitada em detalhes. |
| Obter detalhes da lista de endereçamento |
Recupere os detalhes de uma determinada lista de endereçamento. |
| Obter detalhes do remetente |
Retorna informações para o remetente especificado identificado por seu endereço de email. |
| Obter estatísticas de campanha |
Recupera uma lista detalhada de estatísticas para uma determinada campanha com base em atividades como emails enviados, abertos, saltados, link clicado etc. |
| Obter remetentes |
Recupera uma lista de remetentes ativos em sua conta. |
| Obter resumo da campanha |
Recupera um resumo básico dos resultados de qualquer campanha enviada, como o número de destinatários, abre, clica, rebate, cancela assinaturas, encaminha etc. até a data. |
| Obter resumo da campanha de teste do AB |
Fornece um resumo básico dos resultados de uma campanha de teste de AB enviada, separadamente para cada versão (A e B), como o número de destinatários, abre, clica, rebate, cancela assinaturas, encaminha etc. até a data. |
| Obter todas as listas de endereçamento ativas |
Recupera uma lista de suas listas de endereçamento ativas em sua conta. |
| Remover um assinante |
Remove um assinante da lista de endereçamento especificada permanentemente. |
| Remover um campo personalizado |
Remove uma definição de campo personalizado da lista de endereçamento especificada. |
| Remover vários assinantes |
Remove permanentemente uma lista de assinantes da lista de endereçamento especificada. |
| Testar uma campanha |
Envia um email de teste de uma campanha de rascunho para uma lista de endereços de email especificados para visualização. |
Adicionar assinante
Adiciona um novo assinante à lista de endereçamento especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
Nome
|
Name | string |
O nome. |
|
|
Email
|
string |
O endereço de email. |
||
|
Tem aceitação dupla externa
|
HasExternalDoubleOptIn | boolean |
Se tem aceitação dupla externa. |
|
|
Campos personalizados
|
CustomFields | array of string |
Os campos personalizados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
ID
|
Context.ID | string |
O identificador. |
|
Nome
|
Context.Name | string |
O nome. |
|
Email
|
Context.Email | string |
O endereço de email. |
|
Data da criação
|
Context.CreatedOn | string |
Quando criado. |
|
Atualizado em
|
Context.UpdatedOn | string |
Quando atualizado. |
|
Cancelar assinatura ativada
|
Context.UnsubscribedOn | string |
Quando não assinado. |
|
Cancelar assinatura da ID
|
Context.UnsubscribedFromID | string |
O identificador não assinado. |
|
Tipo de assinatura
|
Context.SubscribeType | integer |
O tipo de assinatura. |
|
Método Subscribe
|
Context.SubscribeMethod | integer |
O método de assinatura. |
|
Campos personalizados
|
Context.CustomFields | array of object | |
|
ID do campo personalizado
|
Context.CustomFields.CustomFieldID | string |
O identificador de campo personalizado. |
|
Nome
|
Context.CustomFields.Name | string |
O nome. |
|
Value
|
Context.CustomFields.Value | string |
O valor. |
|
Removido em
|
Context.RemovedOn | string |
Quando removido. |
Adicionar vários assinantes
Adiciona vários assinantes em uma lista de endereçamento com uma única chamada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
Tem aceitação dupla externa
|
HasExternalDoubleOptIn | boolean |
Se tem aceitação dupla externa. |
|
|
Nome
|
Name | string |
O nome. |
|
|
Email
|
string |
O endereço de email. |
||
|
Campos personalizados
|
CustomFields | array of string |
Os campos personalizados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | array of object | |
|
ID
|
Context.ID | string |
O identificador. |
|
Nome
|
Context.Name | string |
O nome. |
|
Email
|
Context.Email | string |
O endereço de email. |
|
Data da criação
|
Context.CreatedOn | string |
Quando criado. |
|
Atualizado em
|
Context.UpdatedOn | string |
Quando atualizado. |
|
Cancelar assinatura ativada
|
Context.UnsubscribedOn | string |
Quando não assinado. |
|
Cancelar assinatura da ID
|
Context.UnsubscribedFromID | string |
O identificador não assinado. |
|
Tipo de assinatura
|
Context.SubscribeType | integer |
O tipo de assinatura. |
|
Método Subscribe
|
Context.SubscribeMethod | integer |
O método de assinatura. |
|
Campos personalizados
|
Context.CustomFields | array of object | |
|
ID do campo personalizado
|
Context.CustomFields.CustomFieldID | string |
O identificador de campo personalizado. |
|
Nome
|
Context.CustomFields.Name | string |
O nome. |
|
Value
|
Context.CustomFields.Value | string |
O valor. |
|
Removido em
|
Context.RemovedOn | string |
O removido ativado. |
Agendar uma campanha
Atribui uma data e hora agendadas em que a campanha será entregue.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
|
Data e Hora
|
DateTime | True | string |
A data e a hora. |
|
Timezone
|
Timezone | string |
O fuso horário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Atualizar um assinante
Atualiza um assinante na lista de endereçamento especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
ID do Assinante
|
SubscriberId | True | string |
O identificador do assinante. |
|
Nome
|
Name | string |
O nome. |
|
|
Tem aceitação dupla externa
|
HasExternalDoubleOptIn | boolean |
Se tem aceitação dupla externa. |
|
|
Email
|
string |
O endereço de email. |
||
|
Campos personalizados
|
CustomFields | array of string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
ID
|
Context.ID | string |
O identificador. |
|
Nome
|
Context.Name | string |
O nome. |
|
Email
|
Context.Email | string |
O endereço de email. |
|
Data da criação
|
Context.CreatedOn | string |
Quando criado. |
|
Atualizado em
|
Context.UpdatedOn | string |
Quando atualizado. |
|
Cancelar assinatura ativada
|
Context.UnsubscribedOn | string |
Quando não assinado. |
|
Cancelar assinatura da ID
|
Context.UnsubscribedFromID | string |
O identificador não assinado. |
|
Tipo de assinatura
|
Context.SubscribeType | integer |
O tipo de assinatura. |
|
Método Subscribe
|
Context.SubscribeMethod | integer |
O método de assinatura. |
|
Campos personalizados
|
Context.CustomFields | array of object | |
|
ID do campo personalizado
|
Context.CustomFields.CustomFieldID | string |
O identificador de campo personalizado. |
|
Nome
|
Context.CustomFields.Name | string |
O nome. |
|
Value
|
Context.CustomFields.Value | string |
O valor. |
|
Removido em
|
Context.RemovedOn | string |
Quando removido. |
Atualizar um campo personalizado
Atualiza as propriedades de um campo personalizado existente na lista de endereçamento especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
ID do campo personalizado
|
CustomFieldId | True | string |
O identificador de campo personalizado. |
|
Nome
|
Name | string |
O nome. |
|
|
Tipo de campo personalizado
|
CustomFieldType | string |
O tipo de campo personalizado. |
|
|
Opções
|
Options | string |
As opções. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Atualizar uma campanha de rascunho
Atualiza as propriedades de uma campanha ab de rascunho existente em sua conta. Campanhas não rascunho não podem ser atualizadas. Ignore (Opção ab divisão de campanha) se você quiser criar uma campanha regular.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
|
Nome
|
Name | string |
O nome. |
|
|
Assunto
|
Subject | string |
O assunto. |
|
|
Email do remetente
|
SenderEmail | string |
O endereço de email do remetente. |
|
|
Responder a email
|
ReplyToEmail | string |
A resposta ao endereço de email. |
|
|
Confirmação para email
|
ConfirmationToEmail | string |
A confirmação do endereço de email. |
|
|
Local da Web
|
WebLocation | string |
O local da Web. |
|
|
ID da lista de endereçamento
|
MailingListID | string |
O identificador da lista de endereçamento. |
|
|
ID do Segmento
|
SegmentID | string |
O identificador do segmento. |
|
|
É AB
|
IsAB | string |
O é AB. |
|
|
Tipo de campanha AB
|
ABCampaignType | string |
O tipo de campanha AB. |
|
|
Localização da Web B
|
WebLocationB | string |
O local da Web B. |
|
|
Horas para testar
|
HoursToTest | string |
As horas a serem testadas. |
|
|
Porcentagem de Lista
|
ListPercentage | string |
A porcentagem de lista. |
|
|
Tipo de seleção de vencedor ab
|
ABWinnerSelectionType | string |
O tipo de seleção de vencedor ab. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Atualizar uma lista de endereçamento
Atualiza as propriedades de uma lista de endereçamento existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
Nome
|
Name | string |
O nome. |
|
|
Página de confirmação
|
ConfirmationPage | string |
A página de confirmação. |
|
|
Redirecionar após cancelar a assinatura da página
|
RedirectAfterUnsubscribePage | string |
O redirecionamento após a página de cancelamento da assinatura. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Cancelar assinatura de assinante da lista de endereçamento
Cancela a assinatura de um assinante da lista de endereçamento especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
Email
|
True | string |
O endereço de email. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Cancelar assinatura do assinante da conta
Cancela a assinatura de um assinante da conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Email
|
True | string |
O endereço de email. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Clonar uma campanha existente
Cria uma cópia exata de uma campanha existente. A nova campanha é criada como um rascunho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
ID
|
Context.ID | string |
O identificador. |
|
Nome
|
Context.Name | string |
O nome. |
|
Assunto
|
Context.Subject | string |
O assunto. |
|
Local da Web
|
Context.WebLocation | string |
O local da Web. |
|
Conteúdo HTML
|
Context.HTMLContent | string |
O conteúdo HTML. |
|
Conteúdo Sem Formatação
|
Context.PlainContent | string |
O conteúdo sem formatação. |
|
ID
|
Context.Sender.ID | string |
O identificador. |
|
Nome
|
Context.Sender.Name | string |
O nome. |
|
Email
|
Context.Sender.Email | string |
O endereço de email. |
|
Data da criação
|
Context.Sender.CreatedOn | string |
Quando criado. |
|
Está habilitado
|
Context.Sender.IsEnabled | boolean |
Se está habilitado. |
|
SPF Verificado
|
Context.Sender.SpfVerified | boolean |
Se o SPF foi verificado. |
|
DKIM verificado
|
Context.Sender.DkimVerified | boolean |
Se o DKIM foi verificado. |
|
DKIM Público
|
Context.Sender.DkimPublic | string |
O DKIM público. |
|
Entregue em
|
Context.DeliveredOn | string |
Quando entregue. |
|
ID
|
Context.ReplyToEmail.ID | string |
O identificador. |
|
Nome
|
Context.ReplyToEmail.Name | string |
O nome. |
|
Email
|
Context.ReplyToEmail.Email | string |
O endereço de email. |
|
Data da criação
|
Context.ReplyToEmail.CreatedOn | string |
Quando criado. |
|
Está habilitado
|
Context.ReplyToEmail.IsEnabled | boolean |
Se está habilitado. |
|
SPF Verificado
|
Context.ReplyToEmail.SpfVerified | boolean |
Se o SPF foi verificado. |
|
DKIM verificado
|
Context.ReplyToEmail.DkimVerified | boolean |
Se o DKIM foi verificado. |
|
DKIM Público
|
Context.ReplyToEmail.DkimPublic | string |
O DKIM público. |
|
Data da criação
|
Context.CreatedOn | string |
Quando criado. |
|
Atualizado em
|
Context.UpdatedOn | string |
Quando atualizado. |
|
Agendado para
|
Context.ScheduledFor | string |
Quando agendado para. |
|
Timezone
|
Context.Timezone | string |
O fuso horário. |
|
Tipo de formato
|
Context.FormatType | integer |
O tipo de formato. |
|
ID
|
Context.ABCampaignData.ID | integer |
O identificador. |
|
Assunto B
|
Context.ABCampaignData.SubjectB | string |
O assunto B. |
|
Conteúdo Sem Formatação B
|
Context.ABCampaignData.PlainContentB | string |
O conteúdo sem formatação B. |
|
Conteúdo HTML B
|
Context.ABCampaignData.HTMLContentB | string |
O conteúdo HTML B. |
|
Localização da Web B
|
Context.ABCampaignData.WebLocationB | string |
O local da Web B. |
|
Remetente B
|
Context.ABCampaignData.SenderB | string |
O remetente B. |
|
Horas para testar
|
Context.ABCampaignData.HoursToTest | integer |
As horas a serem testadas. |
|
Porcentagem de Lista
|
Context.ABCampaignData.ListPercentage | integer |
A porcentagem de lista. |
|
Tipo de campanha AB
|
Context.ABCampaignData.ABCampaignType | integer |
O tipo de campanha AB. |
|
Tipo de seleção de vencedor ab
|
Context.ABCampaignData.ABWinnerSelectionType | integer |
O tipo de seleção de vencedor ab. |
|
Uma entrega ativada
|
Context.ABCampaignData.DeliveredOnA | string |
O A foi entregue. |
|
B Entregue
|
Context.ABCampaignData.DeliveredOnB | string |
O B entregou. |
|
Listas
|
Context.MailingLists | array of object | |
|
ID da lista de endereçamento
|
Context.MailingLists.MailingListID | string |
O identificador da lista de endereçamento. |
|
ID do Segmento
|
Context.MailingLists.SegmentID | integer |
O identificador do segmento. |
|
Confirmação para
|
Context.ConfirmationTo | string |
A confirmação para. |
|
Situação
|
Context.Status | integer |
O status. |
|
É transacional
|
Context.IsTransactional | boolean |
Se é transacional. |
Criar um campo personalizado
Cria um novo campo personalizado na lista de endereçamento especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
Nome
|
Name | string |
O nome. |
|
|
Tipo de campo personalizado
|
CustomFieldType | string |
O tipo de campo personalizado. |
|
|
Opções
|
Options | string |
As opções. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Criar uma campanha de rascunho
Cria uma nova campanha de rascunho em sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
Name | string |
O nome. |
|
|
Assunto
|
Subject | string |
O assunto. |
|
|
Email do remetente
|
SenderEmail | string |
O endereço de email do remetente. |
|
|
Responder a email
|
ReplyToEmail | string |
A resposta ao endereço de email. |
|
|
Confirmação para email
|
ConfirmationToEmail | string |
A confirmação do endereço de email. |
|
|
Local da Web
|
WebLocation | string |
O local da Web. |
|
|
ID da lista de endereçamento
|
MailingListID | string |
O identificador da lista de endereçamento. |
|
|
ID do Segmento
|
SegmentID | string |
O identificador do segmento. |
|
|
É AB
|
IsAB | string |
O é AB. |
|
|
Tipo de campanha AB
|
ABCampaignType | string |
O tipo de campanha AB. |
|
|
Localização da Web B
|
WebLocationB | string |
O local da Web B. |
|
|
Horas para testar
|
HoursToTest | string |
As horas a serem testadas. |
|
|
Porcentagem de Lista
|
ListPercentage | string |
A porcentagem de lista. |
|
|
Tipo de seleção de vencedor ab
|
ABWinnerSelectionType | string |
O tipo de seleção de vencedor ab. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Criar uma lista de endereçamento
Cria uma nova lista de endereçamento vazia em sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
Name | string |
O nome. |
|
|
Página de confirmação
|
ConfirmationPage | string |
A página de confirmação. |
|
|
Redirecionar após cancelar a assinatura da página
|
RedirectAfterUnsubscribePage | string |
O redirecionamento após a página de cancelamento da assinatura. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Desmarcar uma campanha
Remove uma data e hora previamente definidas de uma campanha, para que ela seja entregue imediatamente se já estiver na fila ou quando enviada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Enviar uma campanha
Envia uma campanha de rascunho existente para todos os destinatários especificados em sua lista de endereçamento. A campanha é enviada imediatamente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Excluir uma campanha
Exclui uma campanha de sua conta, rascunho ou até mesmo enviada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Excluir uma lista de endereçamento
Exclui uma lista de endereçamento da sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Obter assinante por endereço de email
Pesquisa um assinante com o endereço de email especificado na lista de endereçamento especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
Email
|
True | string |
O endereço de email. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
ID
|
Context.ID | string |
O identificador. |
|
Nome
|
Context.Name | string |
O nome. |
|
Email
|
Context.Email | string |
O endereço de email. |
|
Data da criação
|
Context.CreatedOn | string |
Quando criado. |
|
Atualizado em
|
Context.UpdatedOn | string |
Quando atualizado. |
|
Cancelar assinatura ativada
|
Context.UnsubscribedOn | string |
Quando não assinado. |
|
Cancelar assinatura da ID
|
Context.UnsubscribedFromID | string |
O identificador não assinado. |
|
Tipo de assinatura
|
Context.SubscribeType | integer |
O tipo de assinatura. |
|
Método Subscribe
|
Context.SubscribeMethod | integer |
O método de assinatura. |
|
Campos personalizados
|
Context.CustomFields | array of object | |
|
ID do campo personalizado
|
Context.CustomFields.CustomFieldID | string |
O identificador de campo personalizado. |
|
Nome
|
Context.CustomFields.Name | string |
O nome. |
|
Value
|
Context.CustomFields.Value | string |
O valor. |
|
Removido em
|
Context.RemovedOn | string |
Quando removido. |
Obter assinante por ID
Pesquisa um assinante com o identificador exclusivo especificado na lista de endereçamento especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
ID do Assinante
|
SubscriberId | True | string |
O identificador do assinante. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
ID
|
Context.ID | string |
O identificador. |
|
Nome
|
Context.Name | string |
O nome. |
|
Email
|
Context.Email | string |
O endereço de email. |
|
Data da criação
|
Context.CreatedOn | string |
Quando criado. |
|
Atualizado em
|
Context.UpdatedOn | string |
Quando atualizado. |
|
Cancelar assinatura ativada
|
Context.UnsubscribedOn | string |
Quando não assinado. |
|
Cancelar assinatura da ID
|
Context.UnsubscribedFromID | string |
O identificador não assinado. |
|
Tipo de assinatura
|
Context.SubscribeType | integer |
O tipo de assinatura. |
|
Método Subscribe
|
Context.SubscribeMethod | integer |
O método de assinatura. |
|
Campos personalizados
|
Context.CustomFields | array of |
Os campos personalizados. |
|
Removido em
|
Context.RemovedOn | string |
Quando removido. |
Obter assinantes
Recupera uma lista de todos os assinantes em uma determinada lista de endereçamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
Página
|
Page | integer |
A página. |
|
|
Tamanho da Página
|
PageSize | integer |
O tamanho da página. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Tamanho da Página
|
Context.Paging.PageSize | integer |
O tamanho da página. |
|
Página Atual
|
Context.Paging.CurrentPage | integer |
A página atual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
O total de resultados. |
|
Contagem total de páginas
|
Context.Paging.TotalPageCount | integer |
A contagem total de páginas. |
|
Expressão de classificação
|
Context.Paging.SortExpression | string |
A expressão de classificação. |
|
Classificar é crescente
|
Context.Paging.SortIsAscending | boolean |
Se a classificação é crescente. |
|
Subscribers
|
Context.Subscribers | array of object | |
|
ID
|
Context.Subscribers.ID | string |
O identificador. |
|
Nome
|
Context.Subscribers.Name | string |
O nome. |
|
Email
|
Context.Subscribers.Email | string |
O endereço de email. |
|
Data da criação
|
Context.Subscribers.CreatedOn | string |
Quando criado. |
|
Atualizado em
|
Context.Subscribers.UpdatedOn | string |
O atualizado. |
|
Cancelar assinatura ativada
|
Context.Subscribers.UnsubscribedOn | string |
Quando não assinado. |
|
Cancelar assinatura da ID
|
Context.Subscribers.UnsubscribedFromID | string |
O identificador não assinado. |
|
Tipo de assinatura
|
Context.Subscribers.SubscribeType | integer |
O tipo de assinatura. |
|
Método Subscribe
|
Context.Subscribers.SubscribeMethod | integer |
O método de assinatura. |
|
Campos personalizados
|
Context.Subscribers.CustomFields | array of object | |
|
ID do campo personalizado
|
Context.Subscribers.CustomFields.CustomFieldID | string |
O identificador de campo personalizado. |
|
Nome
|
Context.Subscribers.CustomFields.Name | string |
O nome. |
|
Value
|
Context.Subscribers.CustomFields.Value | string |
O valor. |
|
Removido em
|
Context.Subscribers.RemovedOn | string |
Quando removido. |
Obter atividade de link
Retorna uma lista com seus links de campanha e quantos cliques foram feitos por seus destinatários, sejam exclusivos ou totais.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Tamanho da Página
|
Context.Paging.PageSize | integer |
O tamanho da página. |
|
Página Atual
|
Context.Paging.CurrentPage | integer |
A página atual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
O total de resultados. |
|
Contagem total de páginas
|
Context.Paging.TotalPageCount | integer |
A contagem total de páginas. |
|
Expressão de classificação
|
Context.Paging.SortExpression | string |
A expressão de classificação. |
|
Classificar é crescente
|
Context.Paging.SortIsAscending | boolean |
Se a classificação é crescente. |
|
Análises de dados
|
Context.Analytics | array of object | |
|
Contexto
|
Context.Analytics.Context | string |
O contexto. |
|
Nome do Contexto
|
Context.Analytics.ContextName | string |
O nome do contexto. |
|
Contagem total
|
Context.Analytics.TotalCount | integer |
A contagem total. |
|
Contagem Exclusiva
|
Context.Analytics.UniqueCount | integer |
A contagem exclusiva. |
|
Descrição do contexto
|
Context.Analytics.ContextDescription | string |
A descrição do contexto. |
Obter atividade por local
Retorna um relatório detalhado de sua campanha aberto (exclusivo e total) por país.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Tamanho da Página
|
Context.Paging.PageSize | integer |
O tamanho da página. |
|
Página Atual
|
Context.Paging.CurrentPage | integer |
A página atual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
O total de resultados. |
|
Contagem total de páginas
|
Context.Paging.TotalPageCount | integer |
A contagem total de páginas. |
|
Expressão de classificação
|
Context.Paging.SortExpression | string |
A expressão de classificação. |
|
Classificar é crescente
|
Context.Paging.SortIsAscending | boolean |
Se a classificação é crescente. |
|
Análises de dados
|
Context.Analytics | array of object | |
|
Contexto
|
Context.Analytics.Context | string |
O contexto. |
|
Nome do Contexto
|
Context.Analytics.ContextName | string |
O nome do contexto. |
|
Contagem total
|
Context.Analytics.TotalCount | integer |
A contagem total. |
|
Contagem Exclusiva
|
Context.Analytics.UniqueCount | integer |
A contagem exclusiva. |
|
Descrição do contexto
|
Context.Analytics.ContextDescription | string |
A descrição do contexto. |
Obter campanhas
Retorna uma lista de todas as campanhas em sua conta com informações detalhadas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
Page | True | string |
A página. |
|
Tamanho da Página
|
PageSize | True | string |
O tamanho da página. |
|
Classificar Por
|
SortBy | string |
A classificação por. |
|
|
Método Sort
|
SortMethod | string |
O método de classificação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Tamanho da Página
|
Context.Paging.PageSize | integer |
O tamanho da página. |
|
Página Atual
|
Context.Paging.CurrentPage | integer |
A página atual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
O total de resultados. |
|
Contagem total de páginas
|
Context.Paging.TotalPageCount | integer |
A contagem total de páginas. |
|
Expressão de classificação
|
Context.Paging.SortExpression | string |
A expressão de classificação. |
|
Classificar é crescente
|
Context.Paging.SortIsAscending | boolean |
Se a classificação é crescente. |
|
Campaigns
|
Context.Campaigns | array of object | |
|
ID
|
Context.Campaigns.ID | string |
O identificador. |
|
Nome
|
Context.Campaigns.Name | string |
O nome. |
|
Assunto
|
Context.Campaigns.Subject | string |
O assunto. |
|
Nome do Site
|
Context.Campaigns.SiteName | string |
O nome do site. |
|
Confirmação para
|
Context.Campaigns.ConfirmationTo | string |
A confirmação para. |
|
Data da criação
|
Context.Campaigns.CreatedOn | string |
Quando criado. |
|
Horas AB para testar
|
Context.Campaigns.ABHoursToTest | string |
As horas ab para testar. |
|
Tipo de campanha AB
|
Context.Campaigns.ABCampaignType | string |
O tipo de campanha AB. |
|
Vencedor A/B
|
Context.Campaigns.ABWinner | string |
O vencedor do AB. |
|
Tipo de seleção de vencedor ab
|
Context.Campaigns.ABWinnerSelectionType | string |
O tipo de seleção de vencedor ab. |
|
Situação
|
Context.Campaigns.Status | integer |
O status. |
|
Entregue em
|
Context.Campaigns.DeliveredOn | string |
Quando entregue. |
|
Agendado para
|
Context.Campaigns.ScheduledFor | string |
Quando agendado para. |
|
Agendado para Fuso Horário
|
Context.Campaigns.ScheduledForTimezone | string |
O horário agendado para o fuso horário. |
|
Listas
|
Context.Campaigns.MailingLists | array of object | |
|
Campanha
|
Context.Campaigns.MailingLists.Campaign | string |
A campanha. |
|
ID
|
Context.Campaigns.MailingLists.MailingList.ID | string |
O identificador. |
|
Nome
|
Context.Campaigns.MailingLists.MailingList.Name | string |
O nome. |
|
Contagem de membros ativos
|
Context.Campaigns.MailingLists.MailingList.ActiveMemberCount | integer |
A contagem de membros ativos. |
|
Contagem de membros saltados
|
Context.Campaigns.MailingLists.MailingList.BouncedMemberCount | integer |
A contagem de membros saltados. |
|
Contagem de membros removida
|
Context.Campaigns.MailingLists.MailingList.RemovedMemberCount | integer |
A contagem de membros removida. |
|
Contagem de membros não assinados
|
Context.Campaigns.MailingLists.MailingList.UnsubscribedMemberCount | integer |
A contagem de membros não assinados. |
|
Situação
|
Context.Campaigns.MailingLists.MailingList.Status | integer |
O status. |
|
Definição de campos personalizados
|
Context.Campaigns.MailingLists.MailingList.CustomFieldsDefinition | array of |
A definição de campos personalizados. |
|
Criado por
|
Context.Campaigns.MailingLists.MailingList.CreatedBy | string |
O criado por. |
|
Data da criação
|
Context.Campaigns.MailingLists.MailingList.CreatedOn | string |
Quando criado. |
|
Atualizado por
|
Context.Campaigns.MailingLists.MailingList.UpdatedBy | string |
O atualizado por. |
|
Atualizado em
|
Context.Campaigns.MailingLists.MailingList.UpdatedOn | string |
Quando atualizado. |
|
Operação de importação
|
Context.Campaigns.MailingLists.MailingList.ImportOperation | string |
A operação de importação. |
|
Segmento
|
Context.Campaigns.MailingLists.Segment | string |
O segmento. |
|
Total enviado
|
Context.Campaigns.TotalSent | integer |
O total enviado. |
|
Total de Aberturas
|
Context.Campaigns.TotalOpens | integer |
O total é aberto. |
|
Aberturas Exclusivas
|
Context.Campaigns.UniqueOpens | integer |
O exclusivo é aberto. |
|
Total de saltos
|
Context.Campaigns.TotalBounces | integer |
O total de saltos. |
|
Total de Encaminhamentos
|
Context.Campaigns.TotalForwards | integer |
O total de encaminhamentos. |
|
Encaminhamentos exclusivos
|
Context.Campaigns.UniqueForwards | integer |
Os encaminhamentos exclusivos. |
|
Total de cliques de link
|
Context.Campaigns.TotalLinkClicks | integer |
O link total clica. |
|
Cliques de Link Exclusivo
|
Context.Campaigns.UniqueLinkClicks | integer |
O link exclusivo clica. |
|
Contagem de destinatários
|
Context.Campaigns.RecipientsCount | integer |
A contagem de destinatários. |
|
É transacional
|
Context.Campaigns.IsTransactional | boolean |
Se é transacional. |
|
Total de reclamações
|
Context.Campaigns.TotalComplaints | integer |
O total de reclamações. |
|
Total de cancelamentos de assinaturas
|
Context.Campaigns.TotalUnsubscribes | integer |
O total de cancelamentos de assinaturas. |
Obter detalhes da campanha
Retorna um conjunto completo de propriedades que descrevem a campanha solicitada em detalhes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
ID
|
Context.ID | string |
O identificador. |
|
Nome
|
Context.Name | string |
O nome. |
|
Assunto
|
Context.Subject | string |
O assunto. |
|
Local da Web
|
Context.WebLocation | string |
O local da Web. |
|
Conteúdo HTML
|
Context.HTMLContent | string |
O conteúdo HTML. |
|
Conteúdo Sem Formatação
|
Context.PlainContent | string |
O conteúdo sem formatação. |
|
ID
|
Context.Sender.ID | string |
O identificador. |
|
Nome
|
Context.Sender.Name | string |
O nome. |
|
Email
|
Context.Sender.Email | string |
O endereço de email. |
|
Data da criação
|
Context.Sender.CreatedOn | string |
Quando criado. |
|
Está habilitado
|
Context.Sender.IsEnabled | boolean |
Se está habilitado. |
|
SPF Verificado
|
Context.Sender.SpfVerified | boolean |
Se o SPF foi verificado. |
|
DKIM verificado
|
Context.Sender.DkimVerified | boolean |
Se o DKIM foi verificado. |
|
DKIM Público
|
Context.Sender.DkimPublic | string |
O DKIM público. |
|
Entregue em
|
Context.DeliveredOn | string |
Quando entregue. |
|
ID
|
Context.ReplyToEmail.ID | string |
O identificador. |
|
Nome
|
Context.ReplyToEmail.Name | string |
O nome. |
|
Email
|
Context.ReplyToEmail.Email | string |
O endereço de email. |
|
Data da criação
|
Context.ReplyToEmail.CreatedOn | string |
Quando criado. |
|
Está habilitado
|
Context.ReplyToEmail.IsEnabled | boolean |
Se está habilitado. |
|
SPF Verificado
|
Context.ReplyToEmail.SpfVerified | boolean |
Se o SPF foi verificado. |
|
DKIM verificado
|
Context.ReplyToEmail.DkimVerified | boolean |
Se o DKIM foi verificado. |
|
DKIM Público
|
Context.ReplyToEmail.DkimPublic | string |
O DKIM público. |
|
Data da criação
|
Context.CreatedOn | string |
Quando criado. |
|
Atualizado em
|
Context.UpdatedOn | string |
Quando atualizado. |
|
Agendado para
|
Context.ScheduledFor | string |
Quando agendado para. |
|
Timezone
|
Context.Timezone | string |
O fuso horário. |
|
Tipo de formato
|
Context.FormatType | integer |
O tipo de formato. |
|
Dados de campanha do AB
|
Context.ABCampaignData | string |
Os dados da campanha do AB. |
|
Listas
|
Context.MailingLists | array of object | |
|
ID da lista de endereçamento
|
Context.MailingLists.MailingListID | string |
O identificador da lista de endereçamento. |
|
ID do Segmento
|
Context.MailingLists.SegmentID | integer |
O identificador do segmento. |
|
Confirmação para
|
Context.ConfirmationTo | string |
A confirmação para. |
|
Situação
|
Context.Status | integer |
O status. |
|
É transacional
|
Context.IsTransactional | boolean |
Se é transacional. |
Obter detalhes da lista de endereçamento
Recupere os detalhes de uma determinada lista de endereçamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
Com Estatísticas
|
WithStatistics | boolean |
Seja com estatísticas. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
ID
|
Context.ID | string |
O identificador. |
|
Nome
|
Context.Name | string |
O nome. |
|
Contagem de membros ativos
|
Context.ActiveMemberCount | integer |
A contagem de membros ativos. |
|
Contagem de membros saltados
|
Context.BouncedMemberCount | integer |
A contagem de membros saltados. |
|
Contagem de membros removida
|
Context.RemovedMemberCount | integer |
A contagem de membros removida. |
|
Contagem de membros não assinados
|
Context.UnsubscribedMemberCount | integer |
A contagem de membros não assinados. |
|
Situação
|
Context.Status | integer |
O status. |
|
Definição de campos personalizados
|
Context.CustomFieldsDefinition | array of object | |
|
ID
|
Context.CustomFieldsDefinition.ID | string |
O identificador. |
|
Nome
|
Context.CustomFieldsDefinition.Name | string |
O nome. |
|
Contexto
|
Context.CustomFieldsDefinition.Context | string |
O contexto. |
|
É necessário
|
Context.CustomFieldsDefinition.IsRequired | boolean |
Se é necessário. |
|
Tipo
|
Context.CustomFieldsDefinition.Type | integer |
O tipo. |
|
Criado por
|
Context.CreatedBy | string |
O criado por. |
|
Data da criação
|
Context.CreatedOn | string |
Quando criado. |
|
Atualizado por
|
Context.UpdatedBy | string |
O atualizado por. |
|
Atualizado em
|
Context.UpdatedOn | string |
Quando atualizado. |
|
ID
|
Context.ImportOperation.ID | integer |
O identificador. |
|
Hash de dados
|
Context.ImportOperation.DataHash | string |
O hash de dados. |
|
Mapeamentos
|
Context.ImportOperation.Mappings | string |
Os mapeamentos. |
|
Notificação por Email
|
Context.ImportOperation.EmailNotify | string |
A notificação por email. |
|
Data da criação
|
Context.ImportOperation.CreatedOn | string |
Quando criado. |
|
Iniciado em
|
Context.ImportOperation.StartedOn | string |
Quando começou. |
|
Concluído em
|
Context.ImportOperation.CompletedOn | string |
Quando concluído. |
|
Total inserido
|
Context.ImportOperation.TotalInserted | integer |
O total inserido. |
|
Total atualizado
|
Context.ImportOperation.TotalUpdated | integer |
O total atualizado. |
|
Total Desinscrito
|
Context.ImportOperation.TotalUnsubscribed | integer |
O total não assinado. |
|
Total inválido
|
Context.ImportOperation.TotalInvalid | integer |
O total inválido. |
|
Total ignorado
|
Context.ImportOperation.TotalIgnored | integer |
O total ignorado. |
|
Total duplicado
|
Context.ImportOperation.TotalDuplicate | integer |
O total duplicado. |
|
Total de Membros
|
Context.ImportOperation.TotalMembers | integer |
O total de membros. |
|
Message
|
Context.ImportOperation.Message | string |
A mensagem. |
|
Êxito
|
Context.ImportOperation.Success | boolean |
Se bem-sucedido. |
|
Ignorar novos membros
|
Context.ImportOperation.SkipNewMembers | boolean |
Se deve ignorar novos membros. |
Obter detalhes do remetente
Retorna informações para o remetente especificado identificado por seu endereço de email.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Email
|
True | string |
O endereço de email. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
ID
|
Context.ID | string |
O identificador. |
|
Nome
|
Context.Name | string |
O nome. |
|
Email
|
Context.Email | string |
O endereço de email. |
|
Data da criação
|
Context.CreatedOn | string |
Quando criado. |
|
Está habilitado
|
Context.IsEnabled | boolean |
Se está habilitado. |
|
SPF Verificado
|
Context.SpfVerified | boolean |
Se o SPF foi verificado. |
|
DKIM verificado
|
Context.DkimVerified | boolean |
Se o DKIM foi verificado. |
|
DKIM Público
|
Context.DkimPublic | string |
O DKIM público. |
Obter estatísticas de campanha
Recupera uma lista detalhada de estatísticas para uma determinada campanha com base em atividades como emails enviados, abertos, saltados, link clicado etc.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
|
Tipo
|
Type | True | string |
O tipo. |
|
Página
|
Page | integer |
A página. |
|
|
Tamanho da Página
|
PageSize | integer |
O tamanho da página. |
|
|
De
|
From | string |
O endereço De. |
|
|
Para
|
To | string |
O endereço Para. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Tamanho da Página
|
Context.Paging.PageSize | integer |
O tamanho da página. |
|
Página Atual
|
Context.Paging.CurrentPage | integer |
A página atual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
O total de resultados. |
|
Contagem total de páginas
|
Context.Paging.TotalPageCount | integer |
A contagem total de páginas. |
|
Expressão de classificação
|
Context.Paging.SortExpression | string |
A expressão de classificação. |
|
Classificar é crescente
|
Context.Paging.SortIsAscending | boolean |
Se a classificação é crescente. |
|
Análises de dados
|
Context.Analytics | array of object | |
|
Contexto
|
Context.Analytics.Context | string |
O contexto. |
|
Nome do Contexto
|
Context.Analytics.ContextName | string |
O nome do contexto. |
|
Contagem total
|
Context.Analytics.TotalCount | integer |
A contagem total. |
|
Contagem Exclusiva
|
Context.Analytics.UniqueCount | integer |
A contagem exclusiva. |
|
Descrição do contexto
|
Context.Analytics.ContextDescription | string |
A descrição do contexto. |
Obter remetentes
Recupera uma lista de remetentes ativos em sua conta.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | array of object | |
|
ID
|
Context.ID | string |
O identificador. |
|
Nome
|
Context.Name | string |
O nome. |
|
Email
|
Context.Email | string |
O endereço de email. |
|
Data da criação
|
Context.CreatedOn | string |
Quando criado. |
|
Está habilitado
|
Context.IsEnabled | boolean |
Se está habilitado. |
|
SPF Verificado
|
Context.SpfVerified | boolean |
Se o SPF foi verificado. |
|
DKIM verificado
|
Context.DkimVerified | boolean |
Se o DKIM foi verificado. |
|
DKIM Público
|
Context.DkimPublic | string |
O DKIM público. |
Obter resumo da campanha
Recupera um resumo básico dos resultados de qualquer campanha enviada, como o número de destinatários, abre, clica, rebate, cancela assinaturas, encaminha etc. até a data.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
ID da Campanha
|
Context.CampaignID | string |
O identificador da campanha. |
|
Versão do AB
|
Context.ABVersion | string |
A versão ab. |
|
Nome da Campanha
|
Context.CampaignName | string |
O nome da campanha. |
|
Assunto da campanha
|
Context.CampaignSubject | string |
O assunto da campanha. |
|
Listas
|
Context.MailingLists | array of object | |
|
ID da lista de endereçamento
|
Context.MailingLists.MailingListID | string |
O identificador da lista de endereçamento. |
|
ID do Segmento
|
Context.MailingLists.SegmentID | integer |
O identificador do segmento. |
|
Campanha entregue em
|
Context.CampaignDeliveredOn | string |
Quando a campanha foi entregue. |
|
Para
|
Context.To | string |
O endereço Para. |
|
De
|
Context.From | string |
O endereço De. |
|
Total de Aberturas
|
Context.TotalOpens | integer |
O total é aberto. |
|
Aberturas Exclusivas
|
Context.UniqueOpens | integer |
O exclusivo é aberto. |
|
Total de saltos
|
Context.TotalBounces | integer |
O total de saltos. |
|
Total de reclamações
|
Context.TotalComplaints | integer |
O total de reclamações. |
|
Total de Encaminhamentos
|
Context.TotalForwards | integer |
O total de encaminhamentos. |
|
Encaminhamentos exclusivos
|
Context.UniqueForwards | integer |
Os encaminhamentos exclusivos. |
|
Total de cancelamentos de assinaturas
|
Context.TotalUnsubscribes | integer |
O total de cancelamentos de assinaturas. |
|
Total de cliques de link
|
Context.TotalLinkClicks | integer |
O link total clica. |
|
Cliques de Link Exclusivo
|
Context.UniqueLinkClicks | integer |
O link exclusivo clica. |
|
Enviado
|
Context.Sent | integer |
O número enviado. |
|
A campanha é arquivada
|
Context.CampaignIsArchived | boolean |
Se a campanha foi arquivada. |
Obter resumo da campanha de teste do AB
Fornece um resumo básico dos resultados de uma campanha de teste de AB enviada, separadamente para cada versão (A e B), como o número de destinatários, abre, clica, rebate, cancela assinaturas, encaminha etc. até a data.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
ID da Campanha
|
Context.CampaignID | string |
O identificador da campanha. |
|
ID da Campanha
|
Context.A.CampaignID | string |
O identificador da campanha. |
|
Versão do AB
|
Context.A.ABVersion | integer |
A versão ab. |
|
Nome da Campanha
|
Context.A.CampaignName | string |
O nome da campanha. |
|
Assunto da campanha
|
Context.A.CampaignSubject | string |
O assunto da campanha. |
|
Listas
|
Context.A.MailingLists | array of object | |
|
Campanha
|
Context.A.MailingLists.Campaign | string |
A campanha. |
|
ID
|
Context.A.MailingLists.MailingList.ID | string |
O identificador. |
|
Nome
|
Context.A.MailingLists.MailingList.Name | string |
O nome. |
|
Contagem de membros ativos
|
Context.A.MailingLists.MailingList.ActiveMemberCount | integer |
A contagem de membros ativos. |
|
Contagem de membros saltados
|
Context.A.MailingLists.MailingList.BouncedMemberCount | integer |
A contagem de membros saltados. |
|
Contagem de membros removida
|
Context.A.MailingLists.MailingList.RemovedMemberCount | integer |
A contagem de membros removida. |
|
Contagem de membros não assinados
|
Context.A.MailingLists.MailingList.UnsubscribedMemberCount | integer |
A contagem de membros não assinados. |
|
Situação
|
Context.A.MailingLists.MailingList.Status | integer |
O status. |
|
Definição de campos personalizados
|
Context.A.MailingLists.MailingList.CustomFieldsDefinition | array of |
A definição de campos personalizados. |
|
Criado por
|
Context.A.MailingLists.MailingList.CreatedBy | string |
O criado por. |
|
Data da criação
|
Context.A.MailingLists.MailingList.CreatedOn | string |
Quando criado. |
|
Atualizado por
|
Context.A.MailingLists.MailingList.UpdatedBy | string |
O atualizado por. |
|
Atualizado em
|
Context.A.MailingLists.MailingList.UpdatedOn | string |
O atualizado. |
|
Operação de importação
|
Context.A.MailingLists.MailingList.ImportOperation | string |
A operação de importação. |
|
Segmento
|
Context.A.MailingLists.Segment | string |
O segmento. |
|
Campanha entregue em
|
Context.A.CampaignDeliveredOn | string |
A campanha foi entregue. |
|
Para
|
Context.A.To | string |
O endereço Para. |
|
De
|
Context.A.From | string |
O endereço De. |
|
Total de Aberturas
|
Context.A.TotalOpens | integer |
O total é aberto. |
|
Aberturas Exclusivas
|
Context.A.UniqueOpens | integer |
O exclusivo é aberto. |
|
Total de saltos
|
Context.A.TotalBounces | integer |
O total de saltos. |
|
Total de reclamações
|
Context.A.TotalComplaints | integer |
O total de reclamações. |
|
Total de Encaminhamentos
|
Context.A.TotalForwards | integer |
O total de encaminhamentos. |
|
Encaminhamentos exclusivos
|
Context.A.UniqueForwards | integer |
Os encaminhamentos exclusivos. |
|
Total de cancelamentos de assinaturas
|
Context.A.TotalUnsubscribes | integer |
O total de cancelamentos de assinaturas. |
|
Total de cliques de link
|
Context.A.TotalLinkClicks | integer |
O link total clica. |
|
Cliques de Link Exclusivo
|
Context.A.UniqueLinkClicks | integer |
O link exclusivo clica. |
|
Enviado
|
Context.A.Sent | integer |
O número enviado. |
|
A campanha é arquivada
|
Context.A.CampaignIsArchived | boolean |
Se a campanha foi arquivada. |
|
ID da Campanha
|
Context.B.CampaignID | string |
O identificador da campanha. |
|
Versão do AB
|
Context.B.ABVersion | integer |
A versão ab. |
|
Nome da Campanha
|
Context.B.CampaignName | string |
O nome da campanha. |
|
Assunto da campanha
|
Context.B.CampaignSubject | string |
O assunto da campanha. |
|
Listas
|
Context.B.MailingLists | array of object | |
|
Campanha
|
Context.B.MailingLists.Campaign | string |
A campanha. |
|
ID
|
Context.B.MailingLists.MailingList.ID | string |
O identificador. |
|
Nome
|
Context.B.MailingLists.MailingList.Name | string |
O nome. |
|
Contagem de membros ativos
|
Context.B.MailingLists.MailingList.ActiveMemberCount | integer |
A contagem de membros ativos. |
|
Contagem de membros saltados
|
Context.B.MailingLists.MailingList.BouncedMemberCount | integer |
A contagem de membros saltados. |
|
Contagem de membros removida
|
Context.B.MailingLists.MailingList.RemovedMemberCount | integer |
A contagem de membros removida. |
|
Contagem de membros não assinados
|
Context.B.MailingLists.MailingList.UnsubscribedMemberCount | integer |
A contagem de membros não assinados. |
|
Situação
|
Context.B.MailingLists.MailingList.Status | integer |
O status. |
|
Definição de campos personalizados
|
Context.B.MailingLists.MailingList.CustomFieldsDefinition | array of |
A definição de campos personalizados. |
|
Criado por
|
Context.B.MailingLists.MailingList.CreatedBy | string |
O criado por. |
|
Data da criação
|
Context.B.MailingLists.MailingList.CreatedOn | string |
Quando criado. |
|
Atualizado por
|
Context.B.MailingLists.MailingList.UpdatedBy | string |
O atualizado por. |
|
Atualizado em
|
Context.B.MailingLists.MailingList.UpdatedOn | string |
O atualizado. |
|
Operação de importação
|
Context.B.MailingLists.MailingList.ImportOperation | string |
A operação de importação. |
|
Segmento
|
Context.B.MailingLists.Segment | string |
O segmento. |
|
Campanha entregue em
|
Context.B.CampaignDeliveredOn | string |
A campanha foi entregue. |
|
Para
|
Context.B.To | string |
O endereço Para. |
|
De
|
Context.B.From | string |
O endereço De. |
|
Total de Aberturas
|
Context.B.TotalOpens | integer |
O total é aberto. |
|
Aberturas Exclusivas
|
Context.B.UniqueOpens | integer |
O exclusivo é aberto. |
|
Total de saltos
|
Context.B.TotalBounces | integer |
O total de saltos. |
|
Total de reclamações
|
Context.B.TotalComplaints | integer |
O total de reclamações. |
|
Total de Encaminhamentos
|
Context.B.TotalForwards | integer |
O total de encaminhamentos. |
|
Encaminhamentos exclusivos
|
Context.B.UniqueForwards | integer |
Os encaminhamentos exclusivos. |
|
Total de cancelamentos de assinaturas
|
Context.B.TotalUnsubscribes | integer |
O total de cancelamentos de assinaturas. |
|
Total de cliques de link
|
Context.B.TotalLinkClicks | integer |
O link total clica. |
|
Cliques de Link Exclusivo
|
Context.B.UniqueLinkClicks | integer |
O link exclusivo clica. |
|
Enviado
|
Context.B.Sent | integer |
O número enviado. |
|
A campanha é arquivada
|
Context.B.CampaignIsArchived | boolean |
Se a campanha foi arquivada. |
Obter todas as listas de endereçamento ativas
Recupera uma lista de suas listas de endereçamento ativas em sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
Page | True | integer |
A página. |
|
Tamanho da Página
|
PageSize | True | integer |
O tamanho da página. |
|
Classificar Por
|
SortBy | string |
A classificação por. |
|
|
Método Sort
|
SortMethod | string |
O método de classificação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Tamanho da Página
|
Context.Paging.PageSize | integer |
O tamanho da página. |
|
Página Atual
|
Context.Paging.CurrentPage | integer |
A página atual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
O total de resultados. |
|
Contagem total de páginas
|
Context.Paging.TotalPageCount | integer |
A contagem total de páginas. |
|
Expressão de classificação
|
Context.Paging.SortExpression | string |
A expressão de classificação. |
|
Classificar é crescente
|
Context.Paging.SortIsAscending | boolean |
Se a classificação é crescente. |
|
Listas
|
Context.MailingLists | array of object | |
|
ID
|
Context.MailingLists.ID | string |
O identificador. |
|
Nome
|
Context.MailingLists.Name | string |
O nome. |
|
Contagem de membros ativos
|
Context.MailingLists.ActiveMemberCount | integer |
A contagem de membros ativos. |
|
Contagem de membros saltados
|
Context.MailingLists.BouncedMemberCount | integer |
A contagem de membros saltados. |
|
Contagem de membros removida
|
Context.MailingLists.RemovedMemberCount | integer |
A contagem de membros removida. |
|
Contagem de membros não assinados
|
Context.MailingLists.UnsubscribedMemberCount | integer |
A contagem de membros não assinados. |
|
Situação
|
Context.MailingLists.Status | integer |
O status. |
|
Definição de campos personalizados
|
Context.MailingLists.CustomFieldsDefinition | array of object | |
|
ID
|
Context.MailingLists.CustomFieldsDefinition.ID | string |
O identificador. |
|
Nome
|
Context.MailingLists.CustomFieldsDefinition.Name | string |
O nome. |
|
Contexto
|
Context.MailingLists.CustomFieldsDefinition.Context | string |
O contexto. |
|
É necessário
|
Context.MailingLists.CustomFieldsDefinition.IsRequired | boolean |
Se é necessário. |
|
Tipo
|
Context.MailingLists.CustomFieldsDefinition.Type | integer |
O tipo. |
|
Criado por
|
Context.MailingLists.CreatedBy | string |
O criado por. |
|
Data da criação
|
Context.MailingLists.CreatedOn | string |
Quando criado. |
|
Atualizado por
|
Context.MailingLists.UpdatedBy | string |
O atualizado por. |
|
Atualizado em
|
Context.MailingLists.UpdatedOn | string |
O atualizado. |
|
ID
|
Context.MailingLists.ImportOperation.ID | integer |
O identificador. |
|
Hash de dados
|
Context.MailingLists.ImportOperation.DataHash | string |
O hash de dados. |
|
Mapeamentos
|
Context.MailingLists.ImportOperation.Mappings | string |
Os mapeamentos. |
|
Notificação por Email
|
Context.MailingLists.ImportOperation.EmailNotify | string |
O email de notificação. |
|
Data da criação
|
Context.MailingLists.ImportOperation.CreatedOn | string |
Quando criado. |
|
Iniciado em
|
Context.MailingLists.ImportOperation.StartedOn | string |
Quando começou. |
|
Concluído em
|
Context.MailingLists.ImportOperation.CompletedOn | string |
Quando concluído. |
|
Total inserido
|
Context.MailingLists.ImportOperation.TotalInserted | integer |
O total inserido. |
|
Total atualizado
|
Context.MailingLists.ImportOperation.TotalUpdated | integer |
O total atualizado. |
|
Total Desinscrito
|
Context.MailingLists.ImportOperation.TotalUnsubscribed | integer |
O total não assinado. |
|
Total inválido
|
Context.MailingLists.ImportOperation.TotalInvalid | integer |
O total inválido. |
|
Total duplicado
|
Context.MailingLists.ImportOperation.TotalDuplicate | integer |
O total duplicado. |
|
Total de Membros
|
Context.MailingLists.ImportOperation.TotalMembers | integer |
O total de membros. |
|
Message
|
Context.MailingLists.ImportOperation.Message | string |
A mensagem. |
|
Êxito
|
Context.MailingLists.ImportOperation.Success | boolean |
Se bem-sucedido. |
Remover um assinante
Remove um assinante da lista de endereçamento especificada permanentemente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
Email
|
True | string |
O endereço de email. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Remover um campo personalizado
Remove uma definição de campo personalizado da lista de endereçamento especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
ID do campo personalizado
|
CustomFieldId | True | string |
O identificador de campo personalizado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |
Remover vários assinantes
Remove permanentemente uma lista de assinantes da lista de endereçamento especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista de endereçamento
|
MailingListId | True | string |
O identificador da lista de endereçamento. |
|
Emails
|
Emails | True | string |
Os emails. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Emails ignorados
|
Context.EmailsIgnored | integer |
Os emails ignorados. |
|
Emails processados
|
Context.EmailsProcessed | integer |
Os emails processados. |
Testar uma campanha
Envia um email de teste de uma campanha de rascunho para uma lista de endereços de email especificados para visualização.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
CampaignId | True | string |
O identificador da campanha. |
|
Testar emails
|
TestEmails | True | array of string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Code
|
Code | integer |
O código. |
|
Erro
|
Error | string |
O erro. |
|
Contexto
|
Context | string |
O contexto. |