Moosend (Editora Independente) (Pré-visualização)

O melhor software de email marketing e plataforma de automação de marketing que não vai quebrar o seu banco. Com centenas de modelos de data up-topara escolher, suas campanhas de e-mail marketing serão preparadas para o sucesso.

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 (CCG) - 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 Government - 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 (CCG) - 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 (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Troia Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadados do conector
Editora	Troia Taylor
Sítio Web	https://moosend.com/
Política de privacidade	https://www.sitecore.com/trust/privacy-policy
Categorias	Marketing

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Adicionar subscritor	Adiciona um novo assinante à lista de endereçamento especificada.
Adicionar vários subscritores	Adiciona vários assinantes em uma lista de endereçamento com uma única chamada.
Agende uma campanha	Atribui uma data e hora agendadas para a entrega da campanha.
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 um rascunho de campanha	Atualiza as propriedades de um rascunho de campanha AB existente na sua conta. As campanhas que não sejam de rascunho não podem ser atualizadas. Ignore (AB Split Campaign Option) se quiser criar uma campanha regular.
Atualizar uma lista de endereços	Atualiza as propriedades de uma lista de endereçamento existente.
Cancelar assinatura de assinante da conta	Cancela a inscrição de um assinante da conta.
Cancelar inscrição de assinante da lista de discussão	Cancela a inscrição de um assinante da lista de endereçamento especificada.
Clone uma campanha existente	Cria uma cópia exata de uma campanha existente. A nova campanha é criada como 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 na sua conta.
Criar uma lista de endereços	Cria uma nova lista de correio vazia na sua conta.
Desagendar uma campanha	Remove uma data e hora agendadas 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	Elimina uma campanha da sua conta, rascunho ou até mesmo enviada.
Excluir uma lista de endereçamento	Exclui uma lista de endereçamento da sua conta.
Obter atividade de link	Retorna uma lista com os links da campanha e quantos cliques foram feitos pelos destinatários, exclusivos ou totais.
Obter atividade por localização	Devolve um relatório detalhado das aberturas da sua campanha (único e total) por país.
Obter detalhes da campanha	Retorna um conjunto completo de propriedades que descrevem a campanha solicitada em detalhes.
Obter detalhes da lista de endereços	Recupere detalhes de uma determinada lista de e-mails.
Obter detalhes do remetente	Retorna informações para o remetente especificado identificado por seu endereço de e-mail.
Obter estatísticas da campanha	Recupera uma lista detalhada de estatísticas de uma determinada campanha com base em atividades como e-mails enviados, abertos, devolvidos, links clicados, etc.
Obter remetentes	Recupera uma lista dos remetentes ativos na sua conta.
Obter resumo da campanha	Recupera um resumo básico dos resultados de qualquer campanha enviada, como o número de destinatários, aberturas, cliques, devoluções, cancelamento de inscrições, encaminhamentos, etc. até o momento.
Obter resumo da campanha de teste AB	Fornece um resumo básico dos resultados de uma campanha de teste AB enviada, separadamente para cada versão (A e B), como o número de destinatários, aberturas, cliques, devoluções, cancelamentos de inscrição, encaminhamentos, etc até o momento.
Obter subscritor por endereço de e-mail	Procura um assinante com o endereço de e-mail especificado na lista de endereçamento especificada.
Obter subscritor por ID	Procura um assinante com o identificador exclusivo especificado na lista de endereçamento especificada.
Obter subscritores	Recupera uma lista de todos os assinantes em uma determinada lista de endereçamento.
Obter todas as listas de discussão ativas	Recupera uma lista das suas listas de correio ativas na sua conta.
Receba campanhas	Devolve uma lista de todas as campanhas na sua conta com informações detalhadas.
Remover um campo personalizado	Remove uma definição de campo personalizado da lista de endereçamento especificada.
Remover um subscritor	Remove um assinante da lista de endereçamento especificada permanentemente.
Remover vários subscritores	Remove uma lista de assinantes da lista de endereçamento especificada permanentemente.
Testar uma campanha	Envia um e-mail de teste de uma campanha de rascunho para uma lista de endereços de e-mail especificados para visualização.

Adicionar subscritor

ID da Operação:: SubscriberAdd

Adiciona um novo assinante à lista de endereçamento especificada.

Parâmetros

Name	Chave	Necessá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	Email		string	O endereço de e-mail.
Tem Double Opt In externo	HasExternalDoubleOptIn		boolean	Se tem double opt in externo.
Campos personalizados	CustomFields		array of string	Os campos personalizados.

Devoluções

Name	Caminho	Tipo	Description
Código	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 e-mail.
Criado em	Context.CreatedOn	string	Quando criado em.
Atualizado em	Context.UpdatedOn	string	Quando atualizado.
Cancelar inscrição em	Context.UnsubscribedOn	string	Quando cancelado em.
Cancelar inscrição do ID	Context.UnsubscribedFromID	string	O identificador de cancelamento de inscrição.
Tipo de Subscrição	Context.SubscribeType	integer	O tipo de assinatura.
Método Subscribe	Context.SubscribeMethod	integer	O método de subscrição.
Campos personalizados	Context.CustomFields	array of object
ID de campo personalizado	Context.CustomFields.CustomFieldID	string	O identificador de campo personalizado.
Nome	Context.CustomFields.Name	string	O nome.
Valor	Context.CustomFields.Value	string	O valor.
Removido em	Context.RemovedOn	string	Quando removido em.

Adicionar vários subscritores

ID da Operação:: SubscriberAddBulk

Adiciona vários assinantes em uma lista de endereçamento com uma única chamada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Lista de Endereçamento	MailingListId	True	string	O identificador da lista de endereçamento.
Tem Double Opt In externo	HasExternalDoubleOptIn		boolean	Se tem double opt in externo.
Nome	Name		string	O nome.
Email	Email		string	O endereço de e-mail.
Campos personalizados	CustomFields		array of string	Os campos personalizados.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	array of object
ID	Context.ID	string	O identificador.
Nome	Context.Name	string	O nome.
Email	Context.Email	string	O endereço de e-mail.
Criado em	Context.CreatedOn	string	Quando criado em.
Atualizado em	Context.UpdatedOn	string	Quando atualizado.
Cancelar inscrição em	Context.UnsubscribedOn	string	Quando cancelado em.
Cancelar inscrição do ID	Context.UnsubscribedFromID	string	O identificador de cancelamento de inscrição.
Tipo de Subscrição	Context.SubscribeType	integer	O tipo de assinatura.
Método Subscribe	Context.SubscribeMethod	integer	O método de subscrição.
Campos personalizados	Context.CustomFields	array of object
ID de campo personalizado	Context.CustomFields.CustomFieldID	string	O identificador de campo personalizado.
Nome	Context.CustomFields.Name	string	O nome.
Valor	Context.CustomFields.Value	string	O valor.
Removido em	Context.RemovedOn	string	O removido em.

Agende uma campanha

ID da Operação:: CampaignSchedule

Atribui uma data e hora agendadas para a entrega da campanha.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.
Data Hora	DateTime	True	string	A data e a hora.
Timezone	Timezone		string	O fuso horário.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Atualizar um assinante

ID da Operação:: SubscriberUpdate

Atualiza um assinante na lista de endereçamento especificada.

Parâmetros

Name	Chave	Necessá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 Double Opt In externo	HasExternalDoubleOptIn		boolean	Se tem double opt in externo.
Email	Email		string	O endereço de e-mail.
Campos personalizados	CustomFields		array of string

Devoluções

Name	Caminho	Tipo	Description
Código	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 e-mail.
Criado em	Context.CreatedOn	string	Quando criado em.
Atualizado em	Context.UpdatedOn	string	Quando atualizado.
Cancelar inscrição em	Context.UnsubscribedOn	string	Quando cancelado em.
Cancelar inscrição do ID	Context.UnsubscribedFromID	string	O identificador de cancelamento de inscrição.
Tipo de Subscrição	Context.SubscribeType	integer	O tipo de assinatura.
Método Subscribe	Context.SubscribeMethod	integer	O método de subscrição.
Campos personalizados	Context.CustomFields	array of object
ID de campo personalizado	Context.CustomFields.CustomFieldID	string	O identificador de campo personalizado.
Nome	Context.CustomFields.Name	string	O nome.
Valor	Context.CustomFields.Value	string	O valor.
Removido em	Context.RemovedOn	string	Quando removido em.

Atualizar um campo personalizado

ID da Operação:: FieldUpdate

Atualiza as propriedades de um campo personalizado existente na lista de endereçamento especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Lista de Endereçamento	MailingListId	True	string	O identificador da lista de endereçamento.
ID de 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.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Atualizar um rascunho de campanha

ID da Operação:: CampaignUpdate

Atualiza as propriedades de um rascunho de campanha AB existente na sua conta. As campanhas que não sejam de rascunho não podem ser atualizadas. Ignore (AB Split Campaign Option) se quiser criar uma campanha regular.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.
Nome	Name		string	O nome.
Assunto	Subject		string	O assunto.
E-mail do remetente	SenderEmail		string	O endereço de e-mail do remetente.
Responder ao e-mail	ReplyToEmail		string	A resposta ao endereço de e-mail.
Confirmação para e-mail	ConfirmationToEmail		string	A confirmação para o endereço de e-mail.
Localização Web	WebLocation		string	A localização da web.
ID da Lista de Endereçamento	MailingListID		string	O identificador da lista de endereçamento.
ID do Segmento	SegmentID		string	O identificador de segmento.
É AB	IsAB		string	O é AB.
Tipo de campanha AB	ABCampaignType		string	O tipo de campanha AB.
B Localização Web	WebLocationB		string	A localização da Web B.
Horas para testar	HoursToTest		string	As horas para testar.
Percentagem da lista	ListPercentage		string	A percentagem da lista.
Tipo de Seleção de Vencedores AB	ABWinnerSelectionType		string	O tipo de seleção do vencedor AB.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Atualizar uma lista de endereços

ID da Operação:: ListUpdate

Atualiza as propriedades de uma lista de endereçamento existente.

Parâmetros

Name	Chave	Necessá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 a página de cancelamento de inscrição	RedirectAfterUnsubscribePage		string	O redirecionamento após a página de cancelamento de inscrição.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Cancelar assinatura de assinante da conta

ID da Operação:: UnsubscribeAccount

Cancela a inscrição de um assinante da conta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Email	Email	True	string	O endereço de e-mail.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Cancelar inscrição de assinante da lista de discussão

ID da Operação:: UnsubscribeList

Cancela a inscrição de um assinante da lista de endereçamento especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Lista de Endereçamento	MailingListId	True	string	O identificador da lista de endereçamento.
Email	Email	True	string	O endereço de e-mail.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Clone uma campanha existente

ID da Operação:: CampaignClone

Cria uma cópia exata de uma campanha existente. A nova campanha é criada como rascunho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.

Devoluções

Name	Caminho	Tipo	Description
Código	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.
Localização Web	Context.WebLocation	string	A localização da web.
Conteúdo HTML	Context.HTMLContent	string	O conteúdo HTML.
Conteúdo simples	Context.PlainContent	string	O conteúdo simples.
ID	Context.Sender.ID	string	O identificador.
Nome	Context.Sender.Name	string	O nome.
Email	Context.Sender.Email	string	O endereço de e-mail.
Criado em	Context.Sender.CreatedOn	string	Quando criado em.
Está ativado	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 verificou.
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 e-mail.
Criado em	Context.ReplyToEmail.CreatedOn	string	Quando criado em.
Está ativado	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 verificou.
DKIM Público	Context.ReplyToEmail.DkimPublic	string	O DKIM público.
Criado em	Context.CreatedOn	string	Quando criado em.
Atualizado em	Context.UpdatedOn	string	Quando atualizado.
Agendado para	Context.ScheduledFor	string	Quando agendado.
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 sujeito B.
B Conteúdo simples	Context.ABCampaignData.PlainContentB	string	O conteúdo B simples.
B Conteúdo HTML	Context.ABCampaignData.HTMLContentB	string	O conteúdo HTML B.
B Localização Web	Context.ABCampaignData.WebLocationB	string	A localização da Web B.
B Remetente	Context.ABCampaignData.SenderB	string	O remetente B.
Horas para testar	Context.ABCampaignData.HoursToTest	integer	As horas para testar.
Percentagem da lista	Context.ABCampaignData.ListPercentage	integer	A percentagem da lista.
Tipo de campanha AB	Context.ABCampaignData.ABCampaignType	integer	O tipo de campanha AB.
Tipo de Seleção de Vencedores AB	Context.ABCampaignData.ABWinnerSelectionType	integer	O tipo de seleção do vencedor AB.
A Entregue em	Context.ABCampaignData.DeliveredOnA	string	O A cumpriu.
B Entregue em	Context.ABCampaignData.DeliveredOnB	string	O B cumpriu.
Listas de Endereços	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 de 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

ID da Operação:: FieldCreate

Cria um novo campo personalizado na lista de endereçamento especificada.

Parâmetros

Name	Chave	Necessá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.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Criar uma campanha de rascunho

ID da Operação:: CampaignCreate

Cria uma nova campanha de rascunho na sua conta.

Parâmetros

Name	Chave	Tipo	Description
Nome	Name	string	O nome.
Assunto	Subject	string	O assunto.
E-mail do remetente	SenderEmail	string	O endereço de e-mail do remetente.
Responder ao e-mail	ReplyToEmail	string	A resposta ao endereço de e-mail.
Confirmação para e-mail	ConfirmationToEmail	string	A confirmação para o endereço de e-mail.
Localização Web	WebLocation	string	A localização da web.
ID da Lista de Endereçamento	MailingListID	string	O identificador da lista de endereçamento.
ID do Segmento	SegmentID	string	O identificador de segmento.
É AB	IsAB	string	O é AB.
Tipo de campanha AB	ABCampaignType	string	O tipo de campanha AB.
B Localização Web	WebLocationB	string	A localização da Web B.
Horas para testar	HoursToTest	string	As horas para testar.
Percentagem da lista	ListPercentage	string	A percentagem da lista.
Tipo de Seleção de Vencedores AB	ABWinnerSelectionType	string	O tipo de seleção do vencedor AB.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Criar uma lista de endereços

ID da Operação:: ListCreate

Cria uma nova lista de correio vazia na sua conta.

Parâmetros

Name	Chave	Tipo	Description
Nome	Name	string	O nome.
Página de confirmação	ConfirmationPage	string	A página de confirmação.
Redirecionar após a página de cancelamento de inscrição	RedirectAfterUnsubscribePage	string	O redirecionamento após a página de cancelamento de inscrição.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Desagendar uma campanha

ID da Operação:: CampaignUnschedule

Remove uma data e hora agendadas previamente definidas de uma campanha, para que ela seja entregue imediatamente se já estiver na fila ou quando enviada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Enviar uma campanha

ID da Operação:: CampaignSend

Envia uma campanha de rascunho existente para todos os destinatários especificados em sua lista de endereçamento. A campanha é enviada imediatamente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Excluir uma campanha

ID da Operação:: CampaignDelete

Elimina uma campanha da sua conta, rascunho ou até mesmo enviada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Excluir uma lista de endereçamento

ID da Operação:: ListDelete

Exclui uma lista de endereçamento da sua conta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Lista de Endereçamento	MailingListId	True	string	O identificador da lista de endereçamento.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Obter atividade de link

ID da Operação:: CampaignActivityLink

Retorna uma lista com os links da campanha e quantos cliques foram feitos pelos destinatários, exclusivos ou totais.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.

Devoluções

Name	Caminho	Tipo	Description
Código	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.
Resultados totais	Context.Paging.TotalResults	integer	Os resultados totais.
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.
A classificação é ascendente	Context.Paging.SortIsAscending	boolean	Se o tipo é ascendente.
Analytics	Context.Analytics	array of object
Context	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 Única	Context.Analytics.UniqueCount	integer	A contagem única.
Descrição do contexto	Context.Analytics.ContextDescription	string	A descrição do contexto.

Obter atividade por localização

ID da Operação:: CampaignActivityLocation

Devolve um relatório detalhado das aberturas da sua campanha (único e total) por país.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.

Devoluções

Name	Caminho	Tipo	Description
Código	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.
Resultados totais	Context.Paging.TotalResults	integer	Os resultados totais.
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.
A classificação é ascendente	Context.Paging.SortIsAscending	boolean	Se o tipo é ascendente.
Analytics	Context.Analytics	array of object
Context	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 Única	Context.Analytics.UniqueCount	integer	A contagem única.
Descrição do contexto	Context.Analytics.ContextDescription	string	A descrição do contexto.

Obter detalhes da campanha

ID da Operação:: CampaignGetDetails

Retorna um conjunto completo de propriedades que descrevem a campanha solicitada em detalhes.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.

Devoluções

Name	Caminho	Tipo	Description
Código	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.
Localização Web	Context.WebLocation	string	A localização da web.
Conteúdo HTML	Context.HTMLContent	string	O conteúdo HTML.
Conteúdo simples	Context.PlainContent	string	O conteúdo simples.
ID	Context.Sender.ID	string	O identificador.
Nome	Context.Sender.Name	string	O nome.
Email	Context.Sender.Email	string	O endereço de e-mail.
Criado em	Context.Sender.CreatedOn	string	Quando criado em.
Está ativado	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 verificou.
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 e-mail.
Criado em	Context.ReplyToEmail.CreatedOn	string	Quando criado em.
Está ativado	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 verificou.
DKIM Público	Context.ReplyToEmail.DkimPublic	string	O DKIM público.
Criado em	Context.CreatedOn	string	Quando criado em.
Atualizado em	Context.UpdatedOn	string	Quando atualizado.
Agendado para	Context.ScheduledFor	string	Quando agendado.
Timezone	Context.Timezone	string	O fuso horário.
Tipo de formato	Context.FormatType	integer	O tipo de formato.
Dados da campanha AB	Context.ABCampaignData	string	Os dados da campanha AB.
Listas de Endereços	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 de 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ços

ID da Operação:: ListDetails

Recupere detalhes de uma determinada lista de e-mails.

Parâmetros

Name	Chave	Necessá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.

Devoluções

Name	Caminho	Tipo	Description
Código	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 rejeitados	Context.BouncedMemberCount	integer	A contagem de membros rejeitados.
Contagem de membros removidos	Context.RemovedMemberCount	integer	A contagem de membros removidos.
Contagem de membros não inscritos	Context.UnsubscribedMemberCount	integer	A contagem de membros não inscritos.
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.
Context	Context.CustomFieldsDefinition.Context	string	O contexto.
é obrigatório	Context.CustomFieldsDefinition.IsRequired	boolean	Se é necessário.
Tipo	Context.CustomFieldsDefinition.Type	integer	O tipo.
Criado por	Context.CreatedBy	string	O criado por.
Criado em	Context.CreatedOn	string	Quando criado em.
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 e-mail	Context.ImportOperation.EmailNotify	string	O e-mail notificar.
Criado em	Context.ImportOperation.CreatedOn	string	Quando criado em.
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 de não inscritos	Context.ImportOperation.TotalUnsubscribed	integer	O total de inscritos.
Total inválido	Context.ImportOperation.TotalInvalid	integer	O total inválido.
Total ignorado	Context.ImportOperation.TotalIgnored	integer	O total ignorado.
Total de duplicados	Context.ImportOperation.TotalDuplicate	integer	A duplicata total.
Total de Membros	Context.ImportOperation.TotalMembers	integer	O total de membros.
Message	Context.ImportOperation.Message	string	A mensagem.
Sucesso	Context.ImportOperation.Success	boolean	Se bem-sucedido.
Saltar Novos Membros	Context.ImportOperation.SkipNewMembers	boolean	Se deve ignorar novos membros.

Obter detalhes do remetente

ID da Operação:: SenderGetEmail

Retorna informações para o remetente especificado identificado por seu endereço de e-mail.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Email	Email	True	string	O endereço de e-mail.

Devoluções

Name	Caminho	Tipo	Description
Código	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 e-mail.
Criado em	Context.CreatedOn	string	Quando criado em.
Está ativado	Context.IsEnabled	boolean	Se está habilitado.
SPF verificado	Context.SpfVerified	boolean	Se o SPF foi verificado.
DKIM Verificado	Context.DkimVerified	boolean	Se o DKIM verificou.
DKIM Público	Context.DkimPublic	string	O DKIM público.

Obter estatísticas da campanha

ID da Operação:: CampaignStats

Recupera uma lista detalhada de estatísticas de uma determinada campanha com base em atividades como e-mails enviados, abertos, devolvidos, links clicados, etc.

Parâmetros

Name	Chave	Necessá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.

Devoluções

Name	Caminho	Tipo	Description
Código	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.
Resultados totais	Context.Paging.TotalResults	integer	Os resultados totais.
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.
A classificação é ascendente	Context.Paging.SortIsAscending	boolean	Se o tipo é ascendente.
Analytics	Context.Analytics	array of object
Context	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 Única	Context.Analytics.UniqueCount	integer	A contagem única.
Descrição do contexto	Context.Analytics.ContextDescription	string	A descrição do contexto.

Obter remetentes

ID da Operação:: SenderGet

Recupera uma lista dos remetentes ativos na sua conta.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	array of object
ID	Context.ID	string	O identificador.
Nome	Context.Name	string	O nome.
Email	Context.Email	string	O endereço de e-mail.
Criado em	Context.CreatedOn	string	Quando criado em.
Está ativado	Context.IsEnabled	boolean	Se está habilitado.
SPF verificado	Context.SpfVerified	boolean	Se o SPF foi verificado.
DKIM Verificado	Context.DkimVerified	boolean	Se o DKIM verificou.
DKIM Público	Context.DkimPublic	string	O DKIM público.

Obter resumo da campanha

ID da Operação:: CampaignSummary

Recupera um resumo básico dos resultados de qualquer campanha enviada, como o número de destinatários, aberturas, cliques, devoluções, cancelamento de inscrições, encaminhamentos, etc. até o momento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
ID da Campanha	Context.CampaignID	string	O identificador da campanha.
Versão 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 tema da campanha.
Listas de Endereços	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 de 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 Abre	Context.TotalOpens	integer	O total abre.
Unique Abre	Context.UniqueOpens	integer	O único abre.
Total de rejeições	Context.TotalBounces	integer	O total de saltos.
Total de Reclamações	Context.TotalComplaints	integer	O total de reclamações.
Total Forwards	Context.TotalForwards	integer	O total de avanços.
Avançados Únicos	Context.UniqueForwards	integer	Os avançados únicos.
Total de Cancelamentos	Context.TotalUnsubscribes	integer	O total cancela.
Total de cliques no link	Context.TotalLinkClicks	integer	O total de cliques no link.
Cliques exclusivos em links	Context.UniqueLinkClicks	integer	O link exclusivo clica.
Enviado	Context.Sent	integer	O número enviado.
Campanha arquivada	Context.CampaignIsArchived	boolean	Se a campanha está arquivada.

Obter resumo da campanha de teste AB

ID da Operação:: CampaignABSummary

Fornece um resumo básico dos resultados de uma campanha de teste AB enviada, separadamente para cada versão (A e B), como o número de destinatários, aberturas, cliques, devoluções, cancelamentos de inscrição, encaminhamentos, etc até o momento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.

Devoluções

Name	Caminho	Tipo	Description
Código	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 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 tema da campanha.
Listas de Endereços	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 rejeitados	Context.A.MailingLists.MailingList.BouncedMemberCount	integer	A contagem de membros rejeitados.
Contagem de membros removidos	Context.A.MailingLists.MailingList.RemovedMemberCount	integer	A contagem de membros removidos.
Contagem de membros não inscritos	Context.A.MailingLists.MailingList.UnsubscribedMemberCount	integer	A contagem de membros não inscritos.
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.
Criado em	Context.A.MailingLists.MailingList.CreatedOn	string	Quando criado em.
Atualizado por	Context.A.MailingLists.MailingList.UpdatedBy	string	O atualizado por.
Atualizado em	Context.A.MailingLists.MailingList.UpdatedOn	string	O atualizado em.
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 cumpriu.
Para	Context.A.To	string	O endereço Para.
De	Context.A.From	string	O endereço De.
Total Abre	Context.A.TotalOpens	integer	O total abre.
Unique Abre	Context.A.UniqueOpens	integer	O único abre.
Total de rejeições	Context.A.TotalBounces	integer	O total de saltos.
Total de Reclamações	Context.A.TotalComplaints	integer	O total de reclamações.
Total Forwards	Context.A.TotalForwards	integer	O total de avanços.
Avançados Únicos	Context.A.UniqueForwards	integer	Os avançados únicos.
Total de Cancelamentos	Context.A.TotalUnsubscribes	integer	O total cancela.
Total de cliques no link	Context.A.TotalLinkClicks	integer	O total de cliques no link.
Cliques exclusivos em links	Context.A.UniqueLinkClicks	integer	O link exclusivo clica.
Enviado	Context.A.Sent	integer	O número enviado.
Campanha arquivada	Context.A.CampaignIsArchived	boolean	Se a campanha está arquivada.
ID da Campanha	Context.B.CampaignID	string	O identificador da campanha.
Versão 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 tema da campanha.
Listas de Endereços	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 rejeitados	Context.B.MailingLists.MailingList.BouncedMemberCount	integer	A contagem de membros rejeitados.
Contagem de membros removidos	Context.B.MailingLists.MailingList.RemovedMemberCount	integer	A contagem de membros removidos.
Contagem de membros não inscritos	Context.B.MailingLists.MailingList.UnsubscribedMemberCount	integer	A contagem de membros não inscritos.
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.
Criado em	Context.B.MailingLists.MailingList.CreatedOn	string	Quando criado em.
Atualizado por	Context.B.MailingLists.MailingList.UpdatedBy	string	O atualizado por.
Atualizado em	Context.B.MailingLists.MailingList.UpdatedOn	string	O atualizado em.
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 cumpriu.
Para	Context.B.To	string	O endereço Para.
De	Context.B.From	string	O endereço De.
Total Abre	Context.B.TotalOpens	integer	O total abre.
Unique Abre	Context.B.UniqueOpens	integer	O único abre.
Total de rejeições	Context.B.TotalBounces	integer	O total de saltos.
Total de Reclamações	Context.B.TotalComplaints	integer	O total de reclamações.
Total Forwards	Context.B.TotalForwards	integer	O total de avanços.
Avançados Únicos	Context.B.UniqueForwards	integer	Os avançados únicos.
Total de Cancelamentos	Context.B.TotalUnsubscribes	integer	O total cancela.
Total de cliques no link	Context.B.TotalLinkClicks	integer	O total de cliques no link.
Cliques exclusivos em links	Context.B.UniqueLinkClicks	integer	O link exclusivo clica.
Enviado	Context.B.Sent	integer	O número enviado.
Campanha arquivada	Context.B.CampaignIsArchived	boolean	Se a campanha está arquivada.

Obter subscritor por endereço de e-mail

ID da Operação:: SubscriberGetEmail

Procura um assinante com o endereço de e-mail especificado na lista de endereçamento especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Lista de Endereçamento	MailingListId	True	string	O identificador da lista de endereçamento.
Email	Email	True	string	O endereço de e-mail.

Devoluções

Name	Caminho	Tipo	Description
Código	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 e-mail.
Criado em	Context.CreatedOn	string	Quando criado em.
Atualizado em	Context.UpdatedOn	string	Quando atualizado.
Cancelar inscrição em	Context.UnsubscribedOn	string	Quando cancelado em.
Cancelar inscrição do ID	Context.UnsubscribedFromID	string	O identificador de cancelamento de inscrição.
Tipo de Subscrição	Context.SubscribeType	integer	O tipo de assinatura.
Método Subscribe	Context.SubscribeMethod	integer	O método de subscrição.
Campos personalizados	Context.CustomFields	array of object
ID de campo personalizado	Context.CustomFields.CustomFieldID	string	O identificador de campo personalizado.
Nome	Context.CustomFields.Name	string	O nome.
Valor	Context.CustomFields.Value	string	O valor.
Removido em	Context.RemovedOn	string	Quando removido em.

Obter subscritor por ID

ID da Operação:: SubscriberGetID

Procura um assinante com o identificador exclusivo especificado na lista de endereçamento especificada.

Parâmetros

Name	Chave	Necessá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.

Devoluções

Name	Caminho	Tipo	Description
Código	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 e-mail.
Criado em	Context.CreatedOn	string	Quando criado em.
Atualizado em	Context.UpdatedOn	string	Quando atualizado.
Cancelar inscrição em	Context.UnsubscribedOn	string	Quando cancelado em.
Cancelar inscrição do ID	Context.UnsubscribedFromID	string	O identificador de cancelamento de inscrição.
Tipo de Subscrição	Context.SubscribeType	integer	O tipo de assinatura.
Método Subscribe	Context.SubscribeMethod	integer	O método de subscrição.
Campos personalizados	Context.CustomFields	array of	Os campos personalizados.
Removido em	Context.RemovedOn	string	Quando removido em.

Obter subscritores

ID da Operação:: SubscriberList

Recupera uma lista de todos os assinantes em uma determinada lista de endereçamento.

Parâmetros

Name	Chave	Necessá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.

Devoluções

Name	Caminho	Tipo	Description
Código	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.
Resultados totais	Context.Paging.TotalResults	integer	Os resultados totais.
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.
A classificação é ascendente	Context.Paging.SortIsAscending	boolean	Se o tipo é ascendente.
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 e-mail.
Criado em	Context.Subscribers.CreatedOn	string	Quando criado em.
Atualizado em	Context.Subscribers.UpdatedOn	string	O atualizado em.
Cancelar inscrição em	Context.Subscribers.UnsubscribedOn	string	Quando cancelado em.
Cancelar inscrição do ID	Context.Subscribers.UnsubscribedFromID	string	O identificador de cancelamento de inscrição.
Tipo de Subscrição	Context.Subscribers.SubscribeType	integer	O tipo de assinatura.
Método Subscribe	Context.Subscribers.SubscribeMethod	integer	O método de subscrição.
Campos personalizados	Context.Subscribers.CustomFields	array of object
ID de campo personalizado	Context.Subscribers.CustomFields.CustomFieldID	string	O identificador de campo personalizado.
Nome	Context.Subscribers.CustomFields.Name	string	O nome.
Valor	Context.Subscribers.CustomFields.Value	string	O valor.
Removido em	Context.Subscribers.RemovedOn	string	Quando removido em.

Obter todas as listas de discussão ativas

ID da Operação:: ListActive

Recupera uma lista das suas listas de correio ativas na sua conta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Página	Page	True	integer	A página.
Tamanho da página	PageSize	True	integer	O tamanho da página.
Ordenar Por	SortBy		string	A classificação por.
Método Sort	SortMethod		string	O método de classificação.

Devoluções

Name	Caminho	Tipo	Description
Código	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.
Resultados totais	Context.Paging.TotalResults	integer	Os resultados totais.
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.
A classificação é ascendente	Context.Paging.SortIsAscending	boolean	Se o tipo é ascendente.
Listas de Endereços	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 rejeitados	Context.MailingLists.BouncedMemberCount	integer	A contagem de membros rejeitados.
Contagem de membros removidos	Context.MailingLists.RemovedMemberCount	integer	A contagem de membros removidos.
Contagem de membros não inscritos	Context.MailingLists.UnsubscribedMemberCount	integer	A contagem de membros não inscritos.
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.
Context	Context.MailingLists.CustomFieldsDefinition.Context	string	O contexto.
é obrigató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.
Criado em	Context.MailingLists.CreatedOn	string	Quando criado em.
Atualizado por	Context.MailingLists.UpdatedBy	string	O atualizado por.
Atualizado em	Context.MailingLists.UpdatedOn	string	O atualizado em.
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 e-mail	Context.MailingLists.ImportOperation.EmailNotify	string	O e-mail de notificação.
Criado em	Context.MailingLists.ImportOperation.CreatedOn	string	Quando criado em.
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 de não inscritos	Context.MailingLists.ImportOperation.TotalUnsubscribed	integer	O total de inscritos.
Total inválido	Context.MailingLists.ImportOperation.TotalInvalid	integer	O total inválido.
Total de duplicados	Context.MailingLists.ImportOperation.TotalDuplicate	integer	A duplicata total.
Total de Membros	Context.MailingLists.ImportOperation.TotalMembers	integer	O total de membros.
Message	Context.MailingLists.ImportOperation.Message	string	A mensagem.
Sucesso	Context.MailingLists.ImportOperation.Success	boolean	Se bem-sucedido.

Receba campanhas

ID da Operação:: CampaignGet

Devolve uma lista de todas as campanhas na sua conta com informações detalhadas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Página	Page	True	string	A página.
Tamanho da página	PageSize	True	string	O tamanho da página.
Ordenar Por	SortBy		string	A classificação por.
Método Sort	SortMethod		string	O método de classificação.

Devoluções

Name	Caminho	Tipo	Description
Código	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.
Resultados totais	Context.Paging.TotalResults	integer	Os resultados totais.
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.
A classificação é ascendente	Context.Paging.SortIsAscending	boolean	Se o tipo é ascendente.
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.
Criado em	Context.Campaigns.CreatedOn	string	Quando criado em.
AB Horas Para Testar	Context.Campaigns.ABHoursToTest	string	O AB horas para testar.
Tipo de campanha AB	Context.Campaigns.ABCampaignType	string	O tipo de campanha AB.
Vencedor A/ B	Context.Campaigns.ABWinner	string	O vencedor AB.
Tipo de Seleção de Vencedores AB	Context.Campaigns.ABWinnerSelectionType	string	O tipo de seleção do 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.
Agendado para fuso horário	Context.Campaigns.ScheduledForTimezone	string	O programado para fuso horário.
Listas de Endereços	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 rejeitados	Context.Campaigns.MailingLists.MailingList.BouncedMemberCount	integer	A contagem de membros rejeitados.
Contagem de membros removidos	Context.Campaigns.MailingLists.MailingList.RemovedMemberCount	integer	A contagem de membros removidos.
Contagem de membros não inscritos	Context.Campaigns.MailingLists.MailingList.UnsubscribedMemberCount	integer	A contagem de membros não inscritos.
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.
Criado em	Context.Campaigns.MailingLists.MailingList.CreatedOn	string	Quando criado em.
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 Abre	Context.Campaigns.TotalOpens	integer	O total abre.
Unique Abre	Context.Campaigns.UniqueOpens	integer	O único abre.
Total de rejeições	Context.Campaigns.TotalBounces	integer	O total de saltos.
Total Forwards	Context.Campaigns.TotalForwards	integer	O total de avanços.
Avançados Únicos	Context.Campaigns.UniqueForwards	integer	Os avançados únicos.
Total de cliques no link	Context.Campaigns.TotalLinkClicks	integer	O total de cliques no link.
Cliques exclusivos em links	Context.Campaigns.UniqueLinkClicks	integer	O link exclusivo clica.
Contagem de destinatários	Context.Campaigns.RecipientsCount	integer	Os destinatários contam.
É transacional	Context.Campaigns.IsTransactional	boolean	Se é transacional.
Total de Reclamações	Context.Campaigns.TotalComplaints	integer	O total de reclamações.
Total de Cancelamentos	Context.Campaigns.TotalUnsubscribes	integer	O total cancela.

Remover um campo personalizado

ID da Operação:: FieldDelete

Remove uma definição de campo personalizado da lista de endereçamento especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Lista de Endereçamento	MailingListId	True	string	O identificador da lista de endereçamento.
ID de campo personalizado	CustomFieldId	True	string	O identificador de campo personalizado.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Remover um subscritor

ID da Operação:: UnsubscribeRemove

Remove um assinante da lista de endereçamento especificada permanentemente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Lista de Endereçamento	MailingListId	True	string	O identificador da lista de endereçamento.
Email	Email	True	string	O endereço de e-mail.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Remover vários subscritores

ID da Operação:: UnsubscribeRemoveBulk

Remove uma lista de assinantes da lista de endereçamento especificada permanentemente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Lista de Endereçamento	MailingListId	True	string	O identificador da lista de endereçamento.
E-mails	Emails	True	string	Os e-mails.

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
E-mails ignorados	Context.EmailsIgnored	integer	Os e-mails ignorados.
E-mails processados	Context.EmailsProcessed	integer	Os e-mails processados.

Testar uma campanha

ID da Operação:: CampaignTest

Envia um e-mail de teste de uma campanha de rascunho para uma lista de endereços de e-mail especificados para visualização.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	CampaignId	True	string	O identificador da campanha.
E-mails de teste	TestEmails	True	array of string

Devoluções

Name	Caminho	Tipo	Description
Código	Code	integer	O código.
Erro	Error	string	O erro.
Context	Context	string	O contexto.

Partilhar via

Moosend (Editora Independente) (Pré-visualização)

A criar uma ligação

Padrão

Limites de Limitação

Ações

Adicionar subscritor

Parâmetros

Devoluções

Adicionar vários subscritores

Parâmetros

Devoluções

Agende uma campanha

Parâmetros

Devoluções

Atualizar um assinante

Parâmetros

Devoluções

Atualizar um campo personalizado

Parâmetros

Devoluções

Atualizar um rascunho de campanha

Parâmetros

Devoluções

Atualizar uma lista de endereços

Parâmetros

Devoluções

Cancelar assinatura de assinante da conta

Parâmetros

Devoluções

Cancelar inscrição de assinante da lista de discussão

Parâmetros

Devoluções

Clone uma campanha existente

Parâmetros

Devoluções

Criar um campo personalizado

Parâmetros

Devoluções

Criar uma campanha de rascunho

Parâmetros

Devoluções

Criar uma lista de endereços

Parâmetros

Devoluções

Desagendar uma campanha

Parâmetros

Devoluções

Enviar uma campanha

Parâmetros

Devoluções

Excluir uma campanha

Parâmetros

Devoluções

Excluir uma lista de endereçamento

Parâmetros

Devoluções

Obter atividade de link

Parâmetros

Devoluções

Obter atividade por localização

Parâmetros

Devoluções

Obter detalhes da campanha

Parâmetros

Devoluções

Obter detalhes da lista de endereços

Parâmetros

Devoluções

Obter detalhes do remetente

Parâmetros

Devoluções

Obter estatísticas da campanha

Parâmetros

Devoluções

Obter remetentes

Devoluções

Obter resumo da campanha

Parâmetros

Devoluções