Partilhar via

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

Uma coleção completa de todos os pontos de extremidade e métodos disponíveis publicamente para a API do Mailjet

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 Clemente OLIVIER
URL https://stuffandtacos.azurewebsites.net/
Email clement@carfup.com
Metadados do conector
Editora Clemente Olivier
Sítio Web https://www.mailjet.com/
Política de privacidade https://www.mailjet.com/security-privacy/
Categorias Marketing; Comunicação

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 API/Login securestring A chave API/login emitida pela MailJet Verdade
Segredo da API securestring O segredo da API/PassWord emitido pela MailJet Verdade

Limites de Limitação

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

Ações

Atualizar contato

Atualizar o nome próprio do usuário e o status de exclusão de um contato específico
Atualizar lista de contatos

Atualizar uma lista de contatos específica alterando seu nome e/ou status de exclusão
Atualizar rascunho da campanha

Atualizar um rascunho de campanha existente
Criar Contacto

Adicione um novo contato exclusivo à sua lista global de contatos e selecione seu status de exclusão
Criar Lista de Contactos

Criar uma nova lista de contactos
Criar rascunho de campanha

Crie um novo rascunho de campanha. Os objetos Newsletter e CampaignDraft são diferenciados pelos valores EditMode.
Enviar e-mail v3

Enviar uma mensagem de e-mail via Enviar API v3
Enviar e-mail v3.1

Enviar uma mensagem de e-mail via Enviar API v3.1
Excluir lista de contatos

Excluir uma lista de contatos
Obter Contactos

Recupere uma lista de todos os contatos. Inclui informações sobre status de contato e carimbos de data/hora de criação/atividade
Obter contato por ID

Recuperar um contato específico
Obter dados de contato por ID

Recuperar todas as propriedades e respetivos valores associados a um contato específico
Obter dados de contatos

Obter informações sobre todos os contatos e os valores de propriedade associados a eles
Obter estatísticas de contatos

Recuperar uma lista de estatísticas gerais agregadas de entrega e engajamento, agrupadas por contato
Obter informações de mensagens

Recuperar informações de envio/tamanho/spam sobre todas as mensagens
Obter lista de contactos por ID

Recupere detalhes de uma lista de contatos específica - nome, contagem de assinantes, carimbo de data/hora de criação, status de exclusão.
Obter listas de contactos

Recupere detalhes de todas as listas de contatos - nome, contagem de assinantes, carimbo de data/hora de criação, status de exclusão.
Obter rascunho de campanha por ID

Obter um rascunho de campanha específico e seus detalhes de configuração
Obter rascunho de campanhas

Obter todos os rascunhos de campanha e sua configuração
Obter visão geral da campanha

Obtenha detalhes gerais e estatísticas para todos os rascunhos, objetos de teste AB e/ou campanhas enviadas
Receber mensagens

Obtenha uma lista de mensagens com informações específicas sobre o tipo de conteúdo, rastreamento, envio e entrega

Atualizar contato

ID da Operação:
UpdateContact

Atualizar o nome próprio do usuário e o status de exclusão de um contato específico

Parâmetros

Name Chave Necessário Tipo Description
ID de contato
 contact_ID True string

ID numérico exclusivo do contato que você deseja atualizar
IsExcludedFromCampaigns
 IsExcludedFromCampaigns boolean

Indica se o contato é adicionado à lista de exclusão de campanhas ou não
Nome
 Name string

Nome selecionado pelo usuário para este contato

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of ContactResponse

Data
Total
 Total integer

Total

Atualizar lista de contatos

ID da Operação:
UpdateContactList

Atualizar uma lista de contatos específica alterando seu nome e/ou status de exclusão

Parâmetros

Name Chave Necessário Tipo Description
ID da lista
 list_ID True string

ID numérico exclusivo atribuído a esta lista de contactos
Nome
 Name True string

Nome especificado pelo usuário para esta lista de contatos (deve ser exclusivo)
IsDeleted
 IsDeleted boolean

Quando verdadeiro, a lista de contatos será marcada como Excluído

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of ContactsListResponse

Data
Total
 Total integer

Total

Atualizar rascunho da campanha

ID da Operação:
UpdateCampaignDraft

Atualizar um rascunho de campanha existente

Parâmetros

Name Chave Necessário Tipo Description
ID do rascunho
 draft_ID True integer

ID numérico exclusivo do rascunho da campanha que você deseja atualizar
Tipo de conteúdo
 Content-Type string

Tipo de conteúdo
Current
 Current integer

Current
Modo de edição
 EditMode string

Modo de edição para o rascunho da campanha.
IsStarred
 IsStarred boolean

É estrelado
IsTextPartIncluded
 IsTextPartIncluded boolean

A parte de texto está incluída
ResponderE-mail
 ReplyEmail string

Responder e-mail
Nome do remetente
 SenderName string

Nome do remetente
TemplateID
 TemplateID integer

ID do modelo
Title
 Title string

Title
ContatosListID
 ContactsListID string

ID da Lista de Contactos
ContatosListAlt
 ContactsListAlt string

Lista de Contactos Alt
Localidade
 Locale True string

Localidade
ID de segmentação
 SegmentationID integer

ID de segmentação
SegmentaçãoAlt
 SegmentationAlt string

Segmentação Alt
Remetente
 Sender string

Remetente
RemetenteE-mail
 SenderEmail string

E-mail do remetente
Assunto
 Subject True string

Assunto

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of CampaignDraftResponse

Data
Total
 Total integer

Total

Criar Contacto

ID da Operação:
CreateContact

Adicione um novo contato exclusivo à sua lista global de contatos e selecione seu status de exclusão

Parâmetros

Name Chave Necessário Tipo Description
IsExcludedFromCampaigns
 IsExcludedFromCampaigns string

Indica se o contato é adicionado à lista de exclusão de campanhas ou não
Nome
 Name string

Nome selecionado pelo usuário para este contato
Email
 Email True string

Endereço de e-mail de contato

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of ContactResponse

Data
Total
 Total integer

Total

Criar Lista de Contactos

ID da Operação:
CreateContactList

Criar uma nova lista de contactos

Parâmetros

Name Chave Necessário Tipo Description
Nome
 Name True string

Nome especificado pelo usuário para esta lista de contatos (deve ser exclusivo)
IsDeleted
 IsDeleted boolean

Quando verdadeiro, a lista de contatos será marcada como Excluído

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of ContactsListResponse

Data
Total
 Total integer

Total

Criar rascunho de campanha

ID da Operação:
CreateCampaignDraft

Crie um novo rascunho de campanha. Os objetos Newsletter e CampaignDraft são diferenciados pelos valores EditMode.

Parâmetros

Name Chave Necessário Tipo Description
Current
 Current integer

Current
Modo de edição
 EditMode string

Modo de edição para o rascunho da campanha.
IsStarred
 IsStarred boolean

É estrelado
IsTextPartIncluded
 IsTextPartIncluded boolean

A parte de texto está incluída
ResponderE-mail
 ReplyEmail string

Responder e-mail
Nome do remetente
 SenderName string

Nome do remetente
TemplateID
 TemplateID integer

ID do modelo
Title
 Title string

Title
ContatosListID
 ContactsListID string

ID da Lista de Contactos
ContatosListAlt
 ContactsListAlt string

Lista de Contactos Alt
Localidade
 Locale True string

Localidade
ID de segmentação
 SegmentationID integer

ID de segmentação
SegmentaçãoAlt
 SegmentationAlt string

Segmentação Alt
Remetente
 Sender string

Remetente
RemetenteE-mail
 SenderEmail string

E-mail do remetente
Assunto
 Subject True string

Assunto

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of CampaignDraftResponse

Data
Total
 Total integer

Total

Enviar e-mail v3

ID da Operação:
SendEmailv3

Enviar uma mensagem de e-mail via Enviar API v3

Parâmetros

Name Chave Necessário Tipo Description
Do e-mail
 FromEmail True string

Do e-mail
Do nome
 FromName string

Do nome
Remetente
 Sender boolean

Remetente
E-mail Recipent
 Email string

Email
Nome do Recipent
 Name string

Nome
Para enviar por e-mail
 To True string

Para enviar por e-mail
Endereço eletrónico Cc
 Cc string

Endereço eletrónico Cc
Endereço eletrónico Bcc
 Bcc string

Endereço eletrónico Bcc
Assunto
 Subject string

A linha de assunto do e-mail
Parte de texto
 Text-part string

Parte de texto
Html-parte
 Html-part string

Html-parte
Nome do ficheiro
 Filename string

O nome completo do arquivo (incluindo a extensão do arquivo)
Tipo de conteúdo
 Content-type string

Define o tipo de conteúdo que está sendo enviado usando um tipo MIME
Content
 Content string

Conteúdo codificado em Base64 do arquivo anexado
Nome do ficheiro
 Filename string

Nome do ficheiro
Tipo de conteúdo
 Content-type string

Tipo de conteúdo
Content
 Content string

Content

Devoluções

Name Caminho Tipo Description
Enviado
 Sent array of object

Enviado
Email
 Sent.Email string

Email
ID da mensagem
 Sent.MessageID integer

ID da mensagem
MensagemUUID
 Sent.MessageUUID string

Mensagem UUID

Enviar e-mail v3.1

ID da Operação:
SendEmailv3-1

Enviar uma mensagem de e-mail via Enviar API v3.1

Parâmetros

Name Chave Necessário Tipo Description
Do e-mail
 Email True string

O endereço de e-mail De
Do nome
 Name string

O nome do remetente
Para enviar por e-mail
 Email string

O endereço de e-mail do destinatário
Para nomear
 Name string

O nome do destinatário
E-mail do remetente
 Email string

O endereço de e-mail usado para enviar a mensagem
Nome do remetente
 Name string

Nome selecionado pelo usuário para o endereço de e-mail do remetente
ResponderAo e-mail
 Email string

ResponderAo e-mail
Nome ReplyTo
 Name string

Nome ReplyTo
Endereço eletrónico Cc
 Email string

Endereço eletrónico Cc
Nome Cc
 Name string

Nome Cc
Endereço eletrónico Bcc
 Email string

Endereço eletrónico Bcc
Nome Bcc
 Name string

Nome Bcc
Assunto
 Subject string

A linha de assunto do e-mail.
TextPart
 TextPart string

Fornece a parte Texto da mensagem
HTMLPart
 HTMLPart string

Fornece a parte HTML da mensagem.
TemplateID
 TemplateID integer

ID numérico exclusivo do modelo a ser usado como conteúdo de e-mail.
Nome do ficheiro
 Filename string

O nome completo do arquivo (incluindo a extensão do arquivo)
Tipo de conteúdo
 Content-type string

Define o tipo de conteúdo que está sendo enviado usando um tipo MIME
Content
 Base64Content string

Conteúdo codificado em Base64 do arquivo anexado
Modo Sandbox
 SandboxMode boolean

Modo Sandbox
AdvanceErrorHandling
 AdvanceErrorHandling boolean

Tratamento Avançado de Erros

Devoluções

Name Caminho Tipo Description
Messages
 Messages array of object

Messages
Situação
 Messages.Status string

Situação
Errors
 Messages.Errors array of object

Errors
ErrorIdentifier
 Messages.Errors.ErrorIdentifier string

Identificador de erro
ErrorCode
 Messages.Errors.ErrorCode string

Código de Erro
Código de estado
 Messages.Errors.StatusCode integer

Código de estado
Mensagem de Erro
 Messages.Errors.ErrorMessage string

Mensagem de erro
ErrorRelatedTo
 Messages.Errors.ErrorRelatedTo string

Erro relacionado a
ID Personalizado
 Messages.CustomID string

ID personalizado
Para
 Messages.To array of object

Para
Email
 Messages.To.Email string

Email
MensagemUUID
 Messages.To.MessageUUID string

Mensagem UUID
ID da mensagem
 Messages.To.MessageID integer

ID da mensagem
MessageHref
 Messages.To.MessageHref string

Mensagem Href
Cc
 Messages.Cc array of object

Cc
Email
 Messages.Cc.Email string

Email
MensagemUUID
 Messages.Cc.MessageUUID string

Mensagem UUID
ID da mensagem
 Messages.Cc.MessageID integer

ID da mensagem
MessageHref
 Messages.Cc.MessageHref string

Mensagem Href
Cco
 Messages.Bcc array of object

Cco
Email
 Messages.Bcc.Email string

Email
MensagemUUID
 Messages.Bcc.MessageUUID string

Mensagem UUID
ID da mensagem
 Messages.Bcc.MessageID integer

ID da mensagem
MessageHref
 Messages.Bcc.MessageHref string

Mensagem Href

Excluir lista de contatos

ID da Operação:
DeleteContactList

Excluir uma lista de contatos

Parâmetros

Name Chave Necessário Tipo Description
ID da lista
 list_ID True string

ID da lista

Obter Contactos

ID da Operação:
GetContacts

Recupere uma lista de todos os contatos. Inclui informações sobre status de contato e carimbos de data/hora de criação/atividade

Parâmetros

Name Chave Necessário Tipo Description
Campanha
 Campaign integer

Recupera apenas os contatos visados por este ID de campanha
Lista de Contactos
 ContactsList integer

Recupera apenas os contactos que fazem parte deste ID da Lista de Contactos
IsExcludedFromCampaigns
 IsExcludedFromCampaigns boolean

Recuperará apenas contatos que foram adicionados à lista de exclusão para e-mails de marketing
Limite
 Limit integer

Limitar a resposta a um número selecionado de objetos retornados

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of ContactResponse

Data
Total
 Total integer

Total

Obter contato por ID

ID da Operação:
GetContactByID

Recuperar um contato específico

Parâmetros

Name Chave Necessário Tipo Description
ID de contato
 contact_ID True string

ID numérico exclusivo do contato que você deseja recuperar

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of ContactResponse

Data
Total
 Total integer

Total

Obter dados de contato por ID

ID da Operação:
GetContactDataByID

Recuperar todas as propriedades e respetivos valores associados a um contato específico

Parâmetros

Name Chave Necessário Tipo Description
ID de contato
 contactID True integer

ID numérico exclusivo para o contato, cujas propriedades você deseja recuperar

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of ContactDataResponse

Data
Total
 Total integer

Total

Obter dados de contatos

ID da Operação:
GetContactsData

Obter informações sobre todos os contatos e os valores de propriedade associados a eles

Parâmetros

Name Chave Necessário Tipo Description
Campanha
 Campaign integer

Recupera uma lista de valores de propriedade de contato somente para os contatos que receberam e-mails deste ID de campanha
E-mail de contato
 ContactEmail string

Recupera uma lista de valores de propriedade de contato somente para o contato com este endereço de email
ID da Lista de Contactos
 ContactsList integer

Recupera uma lista de valores de propriedade de contato somente para os contatos que fazem parte dessa ID de lista de contatos
Campos
 Fields string

Várias propriedades podem ser especificadas separando-as por vírgulas
Última atividade na
 LastActivityAt string

Recupera uma lista de valores de propriedade de contato somente para os contatos
Limite
 Limit integer

Limitar a resposta a um número selecionado de objetos retornados
Compensação
 OffSet integer

Recuperar uma lista de objetos a partir de um determinado deslocamento
Contar Apenas
 countOnly boolean

Apenas contagem de retorno.
Ordenar
 Sort string

Especifique um nome de propriedade para esse parâmetro de consulta para classificar os objetos em Dados

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of ContactDataResponse

Data
Total
 Total integer

Total

Obter estatísticas de contatos

ID da Operação:
GetContactsStatistics

Recuperar uma lista de estatísticas gerais agregadas de entrega e engajamento, agrupadas por contato

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of object

Data
BlockedCount
 Data.BlockedCount integer

Contagem bloqueada
BouncedCount
 Data.BouncedCount integer

Contagem de rejeições
ClickedCount
 Data.ClickedCount integer

Contagem de cliques
ID de contato
 Data.ContactID integer

ID de contato
DeferredCount
 Data.DeferredCount integer

Contagem diferida
EntregueContagem
 Data.DeliveredCount integer

Contagem de entregas
HardbouncedCount
 Data.HardbouncedCount integer

Contagem Hardbounced
LastActivityAt
 Data.LastActivityAt date-time

Última atividade na
MarketingContactos
 Data.MarketingContacts integer

Contactos de Marketing
OpenedCount
 Data.OpenedCount integer

Contagem aberta
ProcessedCount
 Data.ProcessedCount integer

Contagem processada
QueuedCount
 Data.QueuedCount integer

Contagem em fila
SoftbouncedCount
 Data.SoftbouncedCount integer

Contagem de rejeição suave
SpamComplaintCount
 Data.SpamComplaintCount integer

Contagem de reclamações de spam
UnsubscribedCount
 Data.UnsubscribedCount integer

Contagem não inscrita
UsuárioMarketingContatos
 Data.UserMarketingContacts integer

Contactos de Marketing do Utilizador
WorkFlowExitedCount
 Data.WorkFlowExitedCount integer

Contagem de saídas do WorkFlow
Total
 Total integer

Total

Obter informações de mensagens

ID da Operação:
GetMessagesInformation

Recuperar informações de envio/tamanho/spam sobre todas as mensagens

Parâmetros

Name Chave Necessário Tipo Description
ID da campanha
 CampaignID integer

Recupera informações apenas sobre mensagens que fazem parte desta campanha
Lista de Contactos
 ContactsList integer

Recupera informações apenas sobre mensagens que foram enviadas para esta lista de contatos
CustomCampaign
 CustomCampaign integer

Recupera informações apenas sobre mensagens que fazem parte de uma campanha com a ID personalizada especificada
De
 From string

Recupera informações apenas sobre mensagens enviadas do endereço de e-mail do remetente especificado
FromDomain
 FromDomain string

Recupera informações apenas sobre mensagens enviadas do domínio do remetente especificado
FromID
 FromID integer

Recupera informações apenas sobre mensagens enviadas a partir do ID de remetente especificado
FromTS
 FromTS date-time

Recupera apenas mensagens enviadas após o carimbo de data/hora especificado

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of MessageInformationResponse

Data
Total
 Total integer

Total

Obter lista de contactos por ID

ID da Operação:
GetContactListByID

Recupere detalhes de uma lista de contatos específica - nome, contagem de assinantes, carimbo de data/hora de criação, status de exclusão.

Parâmetros

Name Chave Necessário Tipo Description
ID numérico exclusivo
 list_ID True string

ID numérico exclusivo atribuído a esta lista de contatos.

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of ContactsListResponse

Data
Total
 Total integer

Total

Obter listas de contactos

ID da Operação:
GetContactLists

Recupere detalhes de todas as listas de contatos - nome, contagem de assinantes, carimbo de data/hora de criação, status de exclusão.

Parâmetros

Name Chave Necessário Tipo Description
Address
 Address string

Recupera apenas a lista de contatos com o endereço exclusivo especificado criado pela Mailjet.
Excluir ID
 ExcludeID integer

Exclui a lista de contatos com ID especificado da resposta.
É excluído ?
 IsDeleted boolean

Quando verdadeiro, recuperará apenas listas excluídas. Quando false, recuperará listas que não são excluídas.
Nome
 Name string

Recupera apenas a lista com o Nome especificado selecionado pelo usuário.
Limite
 Limit integer

Limite a resposta a um número selecionado de objetos retornados.
Compensação
 OffSet integer

Recupere uma lista de objetos a partir de um determinado deslocamento.
Contar Apenas
 countOnly boolean

Retorne apenas as linhas de contagem ou não.
Ordenar
 Sort string

Especifique um nome de propriedade para esse parâmetro de consulta para classificar os objetos em Dados.

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of ContactsListResponse

Data
Total
 Total integer

Total

Obter rascunho de campanha por ID

ID da Operação:
GetCampaignDraftByID

Obter um rascunho de campanha específico e seus detalhes de configuração

Parâmetros

Name Chave Necessário Tipo Description
ID do rascunho
 draft_ID True integer

ID numérico exclusivo do rascunho da campanha que você deseja recuperar.

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of CampaignDraftResponse

Data
Total
 Total integer

Total

Obter rascunho de campanhas

ID da Operação:
GetCampaignsDraft

Obter todos os rascunhos de campanha e sua configuração

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of CampaignDraftResponse

Data
Total
 Total integer

Total

Obter visão geral da campanha

ID da Operação:
GetCampaignOverview

Obtenha detalhes gerais e estatísticas para todos os rascunhos, objetos de teste AB e/ou campanhas enviadas

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of object

Data
ClickedCount
 Data.ClickedCount integer

Contagem de cliques
EntregueContagem
 Data.DeliveredCount integer

Contagem de entregas
Modo de edição
 Data.EditMode string

Modo de edição
EditType
 Data.EditType string

Editar tipo
ID
 Data.ID integer

ID
IDTipe
 Data.IDType string

Tipo de ID
OpenedCount
 Data.OpenedCount integer

Contagem aberta
ProcessedCount
 Data.ProcessedCount integer

Contagem processada
SendTimeStart
 Data.SendTimeStart integer

Início do Tempo de Envio
Estrelado
 Data.Starred boolean

Estrelado
Situação
 Data.Status integer

Situação
Assunto
 Data.Subject string

Assunto
Title
 Data.Title string

Title
Total
 Total integer

Total

Receber mensagens

ID da Operação:
GetMessages

Obtenha uma lista de mensagens com informações específicas sobre o tipo de conteúdo, rastreamento, envio e entrega

Parâmetros

Name Chave Necessário Tipo Description
Contato
 Contact integer

Recupera apenas mensagens enviadas para o ID de contato especificado
ID Personalizado
 CustomID integer

Recupera apenas mensagens marcadas com o CustomID especificado
Destino
 Destination integer

Recupera apenas mensagens enviadas para a ID de destino especificada
FromTS
 FromTS date-time

Recupera apenas mensagens enviadas após o carimbo de data/hora especificado
Limite
 Limit integer

Limitar a resposta a um número selecionado de objetos retornados
FromType
 FromType integer
  • 1 - Transacional
  • 2 - Marketing
  • 3 - Desconhecido

Devoluções

Name Caminho Tipo Description
Contar
 Count integer

Contar
Data
 Data array of MessageResponse

Data
Total
 Total integer

Total

Definições

MessageResponse

Name Caminho Tipo Description
Chegou
 ArrivedAt string

Chegou a
ContagemDeAnexos
 AttachmentCount integer

Contagem de Anexos
AttemptCount
 AttemptCount integer

Contagem de tentativas
ID da campanha
 CampaignID integer

ID da Campanha
ContatoAlt
 ContactAlt string

Entre em contato com Alt
ID de contato
 ContactID integer

ID de contato
Atraso
 Delay number

Atraso
ID do Destino
 DestinationID integer

ID de destino
FilterTime
 FilterTime integer

Tempo de Filtro
ID
 ID integer

ID
IsClickTracked
 IsClickTracked boolean

O clique é rastreado
IsHTMLPartIncluded
 IsHTMLPartIncluded boolean

A parte HTML está incluída
IsOpenTracked
 IsOpenTracked boolean

É Rastreado Aberto
IsTextPartIncluded
 IsTextPartIncluded boolean

A parte de texto está incluída
IsUnsubTracked
 IsUnsubTracked boolean

O cancelamento da assinatura é rastreado
MessageSize
 MessageSize integer

Tamanho da mensagem
ID do remetente
 SenderID integer

ID do remetente
SpamassassinScore
 SpamassassinScore number

Pontuação Spamassassin
SpamassRegras
 SpamassRules string

Regras Spamass
ID do Estado
 StateID integer

ID do Estado
EstadoPermanente
 StatePermanent boolean

Estado Permanente
Situação
 Status string

Situação
Assunto
 Subject string

Assunto
Identificador Único Universal (UUID)
 UUID string

Identificador Único Universal (UUID)

MessageInformationResponse

Name Caminho Tipo Description
ID da campanha
 CampaignID integer

ID da Campanha
ClickTrackedCount
 ClickTrackedCount integer

Clique em Contagem Controlada
ID de contato
 ContactID integer

ID de contato
CriadoNa
 CreatedAt date-time

Criado em
ID
 ID integer

ID
MessageSize
 MessageSize integer

Tamanho da mensagem
OpenTrackedCount
 OpenTrackedCount integer

Abrir contagem controlada
QueuedCount
 QueuedCount integer

Contagem em fila
SendEndAt
 SendEndAt string

Enviar Terminar em
SentCount
 SentCount integer

Contagem enviada
SpamAssassinScore
 SpamAssassinScore number

Pontuação Spam Assassin

ContactResponse

Name Caminho Tipo Description
IsExcludedFromCampaigns
 IsExcludedFromCampaigns boolean

Está excluído deCampanhas
Nome
 Name string

Nome
CriadoNa
 CreatedAt date-time

Criado em
EntregueContagem
 DeliveredCount integer

Contagem de entregas
Email
 Email string

Email
ExclusãoDeCampanhasAtualizadoat
 ExclusionFromCampaignsUpdatedAt string

Exclusão de campanhas atualizadas em
ID
 ID integer

ID
IsOptInPending
 IsOptInPending boolean

O OptIn está pendente
IsSpamReclamando
 IsSpamComplaining boolean

Está reclamando spam
LastActivityAt
 LastActivityAt date-time

Última atividade na
LastUpdateAt
 LastUpdateAt date-time

Última atualização em

ContactsListResponse

Name Caminho Tipo Description
Nome
 Name string

Nome
Address
 Address string

Address
CriadoNa
 CreatedAt date-time

Criado em
ID
 ID integer

ID
AssinanteContagem
 SubscriberCount integer

Contagem de subscritores

CampaignDraftResponse

Name Caminho Tipo Description
AXFraction
 AXFraction integer

Fração AX
AXFractionName
 AXFractionName string

Nome da fração AX
AXTesting
 AXTesting string

Testes AX
Current
 Current integer

Current
Modo de edição
 EditMode string

Modo de edição
IsStarred
 IsStarred boolean

É estrelado
IsTextPartIncluded
 IsTextPartIncluded boolean

O TextPart está incluído
ResponderE-mail
 ReplyEmail string

Responder e-mail
Nome do remetente
 SenderName string

Nome do remetente
TemplateID
 TemplateID integer

ID do modelo
Title
 Title string

Title
ID da campanha
 CampaignID integer

ID da Campanha
ContatosListID
 ContactsListID integer

ID da Lista de Contactos
CriadoNa
 CreatedAt date-time

Criado em
EntreguesAt
 DeliveredAt date-time

Entregue em
ID
 ID integer

ID
Localidade
 Locale string

Localidade
Modificadoat
 ModifiedAt date-time

Modificado em
Preset
 Preset string

Preset
ID de segmentação
 SegmentationID integer

ID de segmentação
Remetente
 Sender string

Remetente
RemetenteE-mail
 SenderEmail string

E-mail do remetente
Situação
 Status integer

Situação
Assunto
 Subject string

Assunto
Endereço URL
 Url string

Endereço URL
Usado
 Used boolean

Usado

ContactDataResponse

Name Caminho Tipo Description
ID de contato
 ContactID integer

ID numérico exclusivo para este contato
Data
 Data array of

Uma matriz JSON contendo propriedades de contato e seus valores
ID
 ID integer

ID numérico exclusivo para o objeto Data deste contato
MethodCollection
 MethodCollection string

MethodCollection