MailJet (Editor Independente) (Versão prévia)
Uma coleção completa de todos os pontos de extremidade e métodos disponíveis publicamente para a API mailjet
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 | Clement OLIVIER |
| URL | https://stuffandtacos.azurewebsites.net/ |
| clement@carfup.com |
| Metadados do conector | |
|---|---|
| Publicador | Clement Olivier |
| Site | https://www.mailjet.com/ |
| Política de privacidade | https://www.mailjet.com/security-privacy/ |
| Categorias | Marketing; Comunicação |
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/Logon da API | secureString | A chave/logon da API emitida pelo MailJet | Verdade |
| Segredo da API | secureString | O segredo da API/PassWord emitido pelo MailJet | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar Contato |
Atualizar o nome e o status de exclusão fornecidos pelo usuário 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 Contato |
Adicione um novo contato exclusivo à sua lista de contatos global e selecione seu status de exclusão |
| Criar lista de contatos |
Criar uma nova lista de contatos |
| Criar rascunho de campanha |
Crie um novo rascunho de campanha. Os objetos Newsletter e CampaignDraft são diferenciados pelos valores EditMode. |
| Enviar Email v3 |
Enviar uma mensagem de email por meio da API de Envio v3 |
| Enviar Email v3.1 |
Enviar uma mensagem de email por meio da API de Envio v3.1 |
| Excluir Lista de Contatos |
Excluir uma lista de contatos |
| Obter contato por ID |
Recuperar um contato específico |
| Obter contatos |
Recupere uma lista de todos os contatos. Inclui informações sobre status do contato e carimbos de data/hora de criação/atividade |
| Obter dados de contato por ID |
Recuperar todas as propriedades e os respectivos 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 de entrega agregada e envolvimento, agrupadas por contato |
| Obter informações sobre mensagens |
Recuperar informações de envio/tamanho/spam sobre todas as mensagens |
| Obter lista de contatos 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 contatos |
Recuperar 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 |
Obter detalhes gerais e estatísticas para todos os rascunhos, objetos de teste ab e/ou campanhas enviadas |
| Receber mensagens |
Obter uma lista de mensagens com informações específicas sobre o tipo de conteúdo, acompanhamento, envio e entrega |
Atualizar Contato
Atualizar o nome e o status de exclusão fornecidos pelo usuário de um contato específico
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contact_ID | True | string |
ID numérica exclusiva do contato que você deseja atualizar |
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Indica se o contato é adicionado à lista de exclusão para campanhas ou não |
|
|
Nome
|
Name | string |
Nome selecionado pelo usuário para este contato |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of ContactResponse |
Dados |
|
Total
|
Total | integer |
Total |
Atualizar Lista de Contatos
Atualizar uma lista de contatos específica alterando seu nome e/ou status de exclusão
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_ID | True | string |
ID numérica exclusiva atribuída a esta lista de contatos |
|
Nome
|
Name | True | string |
Nome especificado pelo usuário para esta lista de contatos (deve ser exclusivo) |
|
IsDeleted
|
IsDeleted | boolean |
Quando true, a lista de contatos será marcada como Excluída |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of ContactsListResponse |
Dados |
|
Total
|
Total | integer |
Total |
Atualizar rascunho da campanha
Atualizar um rascunho de campanha existente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do rascunho
|
draft_ID | True | integer |
ID numérica exclusiva do rascunho da campanha que você deseja atualizar |
|
Tipo de conteúdo
|
Content-Type | string |
Tipo de conteúdo |
|
|
Atual
|
Current | integer |
Atual |
|
|
Modo de Edição
|
EditMode | string |
Edite o modo para o rascunho da campanha. |
|
|
IsStarred
|
IsStarred | boolean |
É Estrelado |
|
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
É parte de texto incluída |
|
|
ReplyEmail
|
ReplyEmail | string |
Responder email |
|
|
SenderName
|
SenderName | string |
Nome do remetente |
|
|
TemplateID
|
TemplateID | integer |
ID do Modelo |
|
|
Title
|
Title | string |
Title |
|
|
ContactsListID
|
ContactsListID | string |
ID da Lista de Contatos |
|
|
ContactsListAlt
|
ContactsListAlt | string |
Lista de Contatos Alt |
|
|
Local
|
Locale | True | string |
Local |
|
SegmentationID
|
SegmentationID | integer |
ID de segmentação |
|
|
SegmentationAlt
|
SegmentationAlt | string |
Segmentação Alt |
|
|
Remetente
|
Sender | string |
Remetente |
|
|
SenderEmail
|
SenderEmail | string |
Email do remetente |
|
|
Assunto
|
Subject | True | string |
Assunto |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of CampaignDraftResponse |
Dados |
|
Total
|
Total | integer |
Total |
Criar Contato
Adicione um novo contato exclusivo à sua lista de contatos global e selecione seu status de exclusão
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | string |
Indica se o contato é adicionado à lista de exclusão para campanhas ou não |
|
|
Nome
|
Name | string |
Nome selecionado pelo usuário para este contato |
|
|
Email
|
True | string |
Contate o endereço de email |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of ContactResponse |
Dados |
|
Total
|
Total | integer |
Total |
Criar lista de contatos
Criar uma nova lista de contatos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
Name | True | string |
Nome especificado pelo usuário para esta lista de contatos (deve ser exclusivo) |
|
IsDeleted
|
IsDeleted | boolean |
Quando true, a lista de contatos será marcada como Excluída |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of ContactsListResponse |
Dados |
|
Total
|
Total | integer |
Total |
Criar rascunho de campanha
Crie um novo rascunho de campanha. Os objetos Newsletter e CampaignDraft são diferenciados pelos valores EditMode.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Atual
|
Current | integer |
Atual |
|
|
Modo de Edição
|
EditMode | string |
Edite o modo para o rascunho da campanha. |
|
|
IsStarred
|
IsStarred | boolean |
É Estrelado |
|
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
É parte de texto incluída |
|
|
ReplyEmail
|
ReplyEmail | string |
Responder email |
|
|
SenderName
|
SenderName | string |
Nome do remetente |
|
|
TemplateID
|
TemplateID | integer |
ID do Modelo |
|
|
Title
|
Title | string |
Title |
|
|
ContactsListID
|
ContactsListID | string |
ID da Lista de Contatos |
|
|
ContactsListAlt
|
ContactsListAlt | string |
Lista de Contatos Alt |
|
|
Local
|
Locale | True | string |
Local |
|
SegmentationID
|
SegmentationID | integer |
ID de segmentação |
|
|
SegmentationAlt
|
SegmentationAlt | string |
Segmentação Alt |
|
|
Remetente
|
Sender | string |
Remetente |
|
|
SenderEmail
|
SenderEmail | string |
Email do remetente |
|
|
Assunto
|
Subject | True | string |
Assunto |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of CampaignDraftResponse |
Dados |
|
Total
|
Total | integer |
Total |
Enviar Email v3
Enviar uma mensagem de email por meio da API de Envio v3
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Por email
|
FromEmail | True | string |
Por email |
|
Nome do Remetente
|
FromName | string |
Nome do Remetente |
|
|
Remetente
|
Sender | boolean |
Remetente |
|
|
Recipent Email
|
string |
|
||
|
Nome do Recipent
|
Name | string |
Nome |
|
|
Para Email
|
To | True | string |
Para Email |
|
Cc Email
|
Cc | string |
Cc Email |
|
|
Cco Email
|
Bcc | string |
Cco Email |
|
|
Assunto
|
Subject | string |
A linha de assunto de email |
|
|
Parte de texto
|
Text-part | string |
Parte de texto |
|
|
Parte html
|
Html-part | string |
Parte html |
|
|
Nome do Arquivo
|
Filename | string |
O nome completo do arquivo (incluindo a extensão de arquivo) |
|
|
Content-type
|
Content-type | string |
Define o tipo de conteúdo enviado usando um tipo MIME |
|
|
Content
|
Content | string |
Conteúdo codificado em Base64 do arquivo anexado |
|
|
Nome do Arquivo
|
Filename | string |
Nome do Arquivo |
|
|
Content-type
|
Content-type | string |
Content-type |
|
|
Content
|
Content | string |
Content |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Enviado
|
Sent | array of object |
Enviado |
|
Email
|
Sent.Email | string |
|
|
MessageID
|
Sent.MessageID | integer |
ID da mensagem |
|
MessageUUID
|
Sent.MessageUUID | string |
UUID de mensagem |
Enviar Email v3.1
Enviar uma mensagem de email por meio da API de Envio v3.1
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Por email
|
True | string |
O endereço de email De |
|
|
Nome do Remetente
|
Name | string |
O nome do remetente |
|
|
Para Email
|
string |
O endereço de email do destinatário |
||
|
Nome
|
Name | string |
O nome do destinatário |
|
|
Email do remetente
|
string |
O endereço de email usado para enviar a mensagem |
||
|
Nome do remetente
|
Name | string |
Nome selecionado pelo usuário para o endereço de email do Remetente |
|
|
ReplyTo Email
|
string |
ReplyTo Email |
||
|
Nome de ReplyTo
|
Name | string |
Nome de ReplyTo |
|
|
Cc Email
|
string |
Cc Email |
||
|
Nome cc
|
Name | string |
Nome cc |
|
|
Cco Email
|
string |
Cco Email |
||
|
Nome da Cco
|
Name | string |
Nome da Cco |
|
|
Assunto
|
Subject | string |
A linha de assunto do email. |
|
|
TextPart
|
TextPart | string |
Fornece a parte texto da mensagem |
|
|
HTMLPart
|
HTMLPart | string |
Fornece a parte HTML da mensagem. |
|
|
TemplateID
|
TemplateID | integer |
ID numérica exclusiva do modelo a ser usado como conteúdo de email. |
|
|
Nome do Arquivo
|
Filename | string |
O nome completo do arquivo (incluindo a extensão de arquivo) |
|
|
Content-type
|
Content-type | string |
Define o tipo de conteúdo enviado usando um tipo MIME |
|
|
Content
|
Base64Content | string |
Conteúdo codificado em Base64 do arquivo anexado |
|
|
SandboxMode
|
SandboxMode | boolean |
Modo de área restrita |
|
|
AdvanceErrorHandling
|
AdvanceErrorHandling | boolean |
Tratamento avançado de erros |
Retornos
| Nome | 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ódigoDeStatus
|
Messages.Errors.StatusCode | integer |
Código de status |
|
Mensagem de Erro
|
Messages.Errors.ErrorMessage | string |
Mensagem de erro |
|
ErrorRelatedTo
|
Messages.Errors.ErrorRelatedTo | string |
Erro relacionado a |
|
CustomID
|
Messages.CustomID | string |
ID personalizada |
|
Para
|
Messages.To | array of object |
Para |
|
Email
|
Messages.To.Email | string |
|
|
MessageUUID
|
Messages.To.MessageUUID | string |
UUID de mensagem |
|
MessageID
|
Messages.To.MessageID | integer |
ID da mensagem |
|
MessageHref
|
Messages.To.MessageHref | string |
Href de mensagem |
|
Cc
|
Messages.Cc | array of object |
Cc |
|
Email
|
Messages.Cc.Email | string |
|
|
MessageUUID
|
Messages.Cc.MessageUUID | string |
UUID de mensagem |
|
MessageID
|
Messages.Cc.MessageID | integer |
ID da mensagem |
|
MessageHref
|
Messages.Cc.MessageHref | string |
Href de mensagem |
|
Bcc
|
Messages.Bcc | array of object |
Bcc |
|
Email
|
Messages.Bcc.Email | string |
|
|
MessageUUID
|
Messages.Bcc.MessageUUID | string |
UUID de mensagem |
|
MessageID
|
Messages.Bcc.MessageID | integer |
ID da mensagem |
|
MessageHref
|
Messages.Bcc.MessageHref | string |
Href de mensagem |
Excluir Lista de Contatos
Excluir uma lista de contatos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_ID | True | string |
ID da lista |
Obter contato por ID
Recuperar um contato específico
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contact_ID | True | string |
ID numérica exclusiva do contato que você deseja recuperar |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of ContactResponse |
Dados |
|
Total
|
Total | integer |
Total |
Obter contatos
Recupere uma lista de todos os contatos. Inclui informações sobre status do contato e carimbos de data/hora de criação/atividade
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Campanha
|
Campaign | integer |
Recupera somente contatos direcionados por esta ID de Campanha |
|
|
ContactsList
|
ContactsList | integer |
Recupera somente contatos que fazem parte desta ID da Lista de Contatos |
|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Recuperará apenas os contatos que foram adicionados à lista de exclusão para emails de marketing |
|
|
Limit
|
Limit | integer |
Limitar a resposta a um número selecionado de objetos retornados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of ContactResponse |
Dados |
|
Total
|
Total | integer |
Total |
Obter dados de contato por ID
Recuperar todas as propriedades e os respectivos valores associados a um contato específico
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contactID | True | integer |
ID numérica exclusiva para o contato, cujas propriedades você deseja recuperar |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of ContactDataResponse |
Dados |
|
Total
|
Total | integer |
Total |
Obter dados de contatos
Obter informações sobre todos os contatos e os valores de propriedade associados a eles
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Campanha
|
Campaign | integer |
Recupera uma lista de valores de propriedade de contato somente para os contatos, que receberam emails desta ID de Campanha |
|
|
Email 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 Contatos
|
ContactsList | integer |
Recupera uma lista de valores de propriedade de contato somente para os contatos que fazem parte dessa ID da lista de contatos |
|
|
Fields
|
Fields | string |
Várias propriedades podem ser especificadas separando-as com vírgulas |
|
|
Última atividade em
|
LastActivityAt | string |
Recupera uma lista de valores de propriedade de contato somente para os contatos |
|
|
Limit
|
Limit | integer |
Limitar a resposta a um número selecionado de objetos retornados |
|
|
Offset
|
OffSet | integer |
Recuperar uma lista de objetos começando de um determinado deslocamento |
|
|
Somente Contagem
|
countOnly | boolean |
Somente contagem de retorno. |
|
|
Classificar
|
Sort | string |
Especifique um nome de propriedade para esse parâmetro de consulta para classificar os objetos em Dados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of ContactDataResponse |
Dados |
|
Total
|
Total | integer |
Total |
Obter estatísticas de contatos
Recuperar uma lista de estatísticas gerais de entrega agregada e envolvimento, agrupadas por contato
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of object |
Dados |
|
BlockedCount
|
Data.BlockedCount | integer |
Contagem Bloqueada |
|
BouncedCount
|
Data.BouncedCount | integer |
Contagem Saltitante |
|
ClickedCount
|
Data.ClickedCount | integer |
Contagem clicada |
|
ContactID
|
Data.ContactID | integer |
ID de contato |
|
DeferredCount
|
Data.DeferredCount | integer |
Contagem Adiada |
|
DeliveredCount
|
Data.DeliveredCount | integer |
Contagem entregue |
|
HardbouncedCount
|
Data.HardbouncedCount | integer |
Contagem hardbounced |
|
LastActivityAt
|
Data.LastActivityAt | date-time |
Última atividade em |
|
MarketingContacts
|
Data.MarketingContacts | integer |
Contatos de marketing |
|
OpenedCount
|
Data.OpenedCount | integer |
Contagem Aberta |
|
ProcessedCount
|
Data.ProcessedCount | integer |
Contagem processada |
|
QueuedCount
|
Data.QueuedCount | integer |
Contagem enfileirada |
|
SoftbouncedCount
|
Data.SoftbouncedCount | integer |
Contagem de saltos suaves |
|
SpamComplaintCount
|
Data.SpamComplaintCount | integer |
Contagem de reclamações de spam |
|
UnsubscribedCount
|
Data.UnsubscribedCount | integer |
Contagem não assinada |
|
UserMarketingContacts
|
Data.UserMarketingContacts | integer |
Contatos de marketing de usuário |
|
WorkFlowExitedCount
|
Data.WorkFlowExitedCount | integer |
Contagem de Saída do Fluxo de Trabalho |
|
Total
|
Total | integer |
Total |
Obter informações sobre mensagens
Recuperar informações de envio/tamanho/spam sobre todas as mensagens
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
CampaignID
|
CampaignID | integer |
Recupera informações apenas sobre mensagens que fazem parte desta campanha |
|
|
ContactsList
|
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 email do remetente especificado |
|
|
FromDomain
|
FromDomain | string |
Recupera informações somente sobre mensagens enviadas do domínio do remetente especificado |
|
|
FromID
|
FromID | integer |
Recupera informações apenas sobre mensagens enviadas da ID do remetente especificada |
|
|
FromTS
|
FromTS | date-time |
Recupera somente mensagens enviadas após o carimbo de data/hora especificado |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of MessageInformationResponse |
Dados |
|
Total
|
Total | integer |
Total |
Obter lista de contatos 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.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID numérica exclusiva
|
list_ID | True | string |
ID numérica exclusiva atribuída a esta lista de contatos. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of ContactsListResponse |
Dados |
|
Total
|
Total | integer |
Total |
Obter listas de contatos
Recuperar detalhes de todas as listas de contatos – nome, contagem de assinantes, carimbo de data/hora de criação, status de exclusão.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Endereço
|
Address | string |
Recupera apenas a lista de contatos com o endereço exclusivo especificado criado pelo Mailjet. |
|
|
Excluir ID
|
ExcludeID | integer |
Exclui a lista de contatos com a ID especificada da resposta. |
|
|
É excluído?
|
IsDeleted | boolean |
Quando true, 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 selecionado pelo usuário especificado. |
|
|
Limit
|
Limit | integer |
Limite a resposta a um número selecionado de objetos retornados. |
|
|
Offset
|
OffSet | integer |
Recupere uma lista de objetos começando de um determinado deslocamento. |
|
|
Somente Contagem
|
countOnly | boolean |
Retorne as linhas de contagem apenas ou não. |
|
|
Classificar
|
Sort | string |
Especifique um nome de propriedade para esse parâmetro de consulta para classificar os objetos em Dados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of ContactsListResponse |
Dados |
|
Total
|
Total | integer |
Total |
Obter rascunho de campanha por ID
Obter um rascunho de campanha específico e seus detalhes de configuração
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do rascunho
|
draft_ID | True | integer |
ID numérica exclusiva do rascunho da campanha que você deseja recuperar. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of CampaignDraftResponse |
Dados |
|
Total
|
Total | integer |
Total |
Obter rascunho de campanhas
Obter todos os rascunhos de campanha e sua configuração
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of CampaignDraftResponse |
Dados |
|
Total
|
Total | integer |
Total |
Obter visão geral da campanha
Obter detalhes gerais e estatísticas para todos os rascunhos, objetos de teste ab e/ou campanhas enviadas
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of object |
Dados |
|
ClickedCount
|
Data.ClickedCount | integer |
Contagem clicada |
|
DeliveredCount
|
Data.DeliveredCount | integer |
Contagem entregue |
|
EditMode
|
Data.EditMode | string |
Modo de Edição |
|
EditType
|
Data.EditType | string |
Tipo de Edição |
|
ID
|
Data.ID | integer |
ID |
|
IDType
|
Data.IDType | string |
Tipo de ID |
|
OpenedCount
|
Data.OpenedCount | integer |
Contagem Aberta |
|
ProcessedCount
|
Data.ProcessedCount | integer |
Contagem processada |
|
SendTimeStart
|
Data.SendTimeStart | integer |
Início da Hora de Envio |
|
Estrelou
|
Data.Starred | boolean |
Estrelou |
|
Situação
|
Data.Status | integer |
Situação |
|
Assunto
|
Data.Subject | string |
Assunto |
|
Title
|
Data.Title | string |
Title |
|
Total
|
Total | integer |
Total |
Receber mensagens
Obter uma lista de mensagens com informações específicas sobre o tipo de conteúdo, acompanhamento, envio e entrega
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Contato
|
Contact | integer |
Recupera somente mensagens enviadas para a ID de Contato especificada |
|
|
CustomID
|
CustomID | integer |
Recupera somente mensagens marcadas com a CustomID especificada |
|
|
Destino
|
Destination | integer |
Recupera somente mensagens enviadas para a ID de Destino especificada |
|
|
FromTS
|
FromTS | date-time |
Recupera somente mensagens enviadas após o carimbo de data/hora especificado |
|
|
Limit
|
Limit | integer |
Limitar a resposta a um número selecionado de objetos retornados |
|
|
FromType
|
FromType | integer |
|
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
Count | integer |
Contagem |
|
Dados
|
Data | array of MessageResponse |
Dados |
|
Total
|
Total | integer |
Total |
Definições
MessageResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ArrivedAt
|
ArrivedAt | string |
Chegou em |
|
AttachmentCount
|
AttachmentCount | integer |
Contagem de Anexos |
|
AttemptCount
|
AttemptCount | integer |
Contagem de tentativas |
|
CampaignID
|
CampaignID | integer |
ID da Campanha |
|
ContactAlt
|
ContactAlt | string |
Contatar Alt |
|
ContactID
|
ContactID | integer |
ID de contato |
|
Atraso
|
Delay | number |
Atraso |
|
DestinationID
|
DestinationID | integer |
ID de destino |
|
FilterTime
|
FilterTime | integer |
Tempo de Filtro |
|
ID
|
ID | integer |
ID |
|
IsClickTracked
|
IsClickTracked | boolean |
Clique em Acompanhamento |
|
IsHTMLPartIncluded
|
IsHTMLPartIncluded | boolean |
A parte HTML está incluída |
|
IsOpenTracked
|
IsOpenTracked | boolean |
É Open Tracked |
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
É parte de texto incluída |
|
IsUnsubTracked
|
IsUnsubTracked | boolean |
Não há assinatura rastreada |
|
MessageSize
|
MessageSize | integer |
Tamanho da Mensagem |
|
SenderID
|
SenderID | integer |
ID do remetente |
|
SpamassassinScore
|
SpamassassinScore | number |
Pontuação de spamassassin |
|
SpamassRules
|
SpamassRules | string |
Regras de Spamass |
|
StateID
|
StateID | integer |
ID do Estado |
|
StatePermanent
|
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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
CampaignID
|
CampaignID | integer |
ID da Campanha |
|
ClickTrackedCount
|
ClickTrackedCount | integer |
Clique em Contagem Controlada |
|
ContactID
|
ContactID | integer |
ID de contato |
|
CreatedAt
|
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 enfileirada |
|
SendEndAt
|
SendEndAt | string |
Enviar final em |
|
SentCount
|
SentCount | integer |
Contagem enviada |
|
SpamAssassinScore
|
SpamAssassinScore | number |
Pontuação do assassino de spam |
ContactResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
É Excluído deCampaigns |
|
Nome
|
Name | string |
Nome |
|
CreatedAt
|
CreatedAt | date-time |
Criado em |
|
DeliveredCount
|
DeliveredCount | integer |
Contagem entregue |
|
Email
|
string |
|
|
|
ExclusionFromCampaignsUpdatedAt
|
ExclusionFromCampaignsUpdatedAt | string |
Exclusão de campanhas atualizadas em |
|
ID
|
ID | integer |
ID |
|
IsOptInPending
|
IsOptInPending | boolean |
O OptIn está pendente |
|
IsSpamComplaining
|
IsSpamComplaining | boolean |
O spam está reclamando |
|
LastActivityAt
|
LastActivityAt | date-time |
Última atividade em |
|
LastUpdateAt
|
LastUpdateAt | date-time |
Última atualização em |
ContactsListResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
Name | string |
Nome |
|
Endereço
|
Address | string |
Endereço |
|
CreatedAt
|
CreatedAt | date-time |
Criado em |
|
ID
|
ID | integer |
ID |
|
SubscriberCount
|
SubscriberCount | integer |
Contagem de Assinantes |
CampaignDraftResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
AXFraction
|
AXFraction | integer |
Fração AX |
|
AXFractionName
|
AXFractionName | string |
Nome da fração AX |
|
AXTesting
|
AXTesting | string |
Teste do AX |
|
Atual
|
Current | integer |
Atual |
|
EditMode
|
EditMode | string |
Modo de Edição |
|
IsStarred
|
IsStarred | boolean |
É Estrelado |
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
É TextPart incluído |
|
ReplyEmail
|
ReplyEmail | string |
Responder email |
|
SenderName
|
SenderName | string |
Nome do remetente |
|
TemplateID
|
TemplateID | integer |
ID do Modelo |
|
Title
|
Title | string |
Title |
|
CampaignID
|
CampaignID | integer |
ID da Campanha |
|
ContactsListID
|
ContactsListID | integer |
ID da Lista de Contatos |
|
CreatedAt
|
CreatedAt | date-time |
Criado em |
|
DeliveredAt
|
DeliveredAt | date-time |
Entregue em |
|
ID
|
ID | integer |
ID |
|
Local
|
Locale | string |
Local |
|
ModifiedAt
|
ModifiedAt | date-time |
Modificado em |
|
Predefinição
|
Preset | string |
Predefinição |
|
SegmentationID
|
SegmentationID | integer |
ID de segmentação |
|
Remetente
|
Sender | string |
Remetente |
|
SenderEmail
|
SenderEmail | string |
Email do remetente |
|
Situação
|
Status | integer |
Situação |
|
Assunto
|
Subject | string |
Assunto |
|
URL
|
Url | string |
URL |
|
Usado
|
Used | boolean |
Usado |
ContactDataResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ContactID
|
ContactID | integer |
ID numérica exclusiva para este contato |
|
Dados
|
Data | array of |
Uma matriz JSON que contém propriedades de contato e seus valores |
|
ID
|
ID | integer |
ID numérica exclusiva para o objeto Data deste contato |
|
MethodCollection
|
MethodCollection | string |
MethodCollection |