Share via


MailJet (Independent Publisher) (Preview)

A complete collection of all publicly available endpoints and methods for the Mailjet API

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Clement OLIVIER
URL https://stuffandtacos.azurewebsites.net/
Email clement@carfup.com
Connector Metadata
Publisher Clement Olivier
Website https://www.mailjet.com/
Privacy policy https://www.mailjet.com/security-privacy/
Categories Marketing; Communication

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key/Login securestring The API Key/Login issued by MailJet True
API Secret securestring The API Secret/PassWord issued by MailJet True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create Campaign Draft

Create a new campaign draft. Newsletter and CampaignDraft objects are differentiated by the EditMode values.

Create Contact

Add a new unique contact to your global contact list and select its exclusion status

Create Contact List

Create a new contact list

Delete Contact List

Delete a contact list

Get Campaign Draft By ID

Get a specific campaign draft and its configuration details

Get Campaign Overview

Get general details and stats for all drafts, AB Testing objects and/or sent campaigns

Get Campaigns Draft

Get all campaign drafts and their configuration

Get Contact By ID

Retrieve a specific contact

Get Contact Data By ID

Retrieve all properties and respective values associated with a specific contact

Get Contact List By ID

Retrieve details for a specific contact list - name, subscriber count, creation timestamp, deletion status.

Get Contact Lists

Retrieve details for all contact lists - name, subscriber count, creation timestamp, deletion status.

Get Contacts

Retrieve a list of all contacts. Includes information about contact status and creation / activity timestamps

Get Contacts Data

Get information on all contacts and the property values associated with them

Get Contacts Statistics

Retrieve a list of overall aggregated delivery and engagement statistics, grouped by contact

Get Messages

Get a list of messages with specific information on the type of content, tracking, sending and delivery

Get Messages Information

Retrieve sending/size/spam information about all messages

Send Email v3

Send an email message via Send API v3

Send Email v3.1

Send an email message via Send API v3.1

Update Campaign Draft

Update an existing campaign draft

Update Contact

Update the user-given name and exclusion status of a specific contact

Update Contact List

Update a specific contact list by changing its name and / or deletion status

Create Campaign Draft

Create a new campaign draft. Newsletter and CampaignDraft objects are differentiated by the EditMode values.

Parameters

Name Key Required Type Description
Current
Current integer

Current

Edit Mode
EditMode string

Edit mode for the campaign draft.

IsStarred
IsStarred boolean

Is Starred

IsTextPartIncluded
IsTextPartIncluded boolean

Is Text Part Included

ReplyEmail
ReplyEmail string

Reply Email

SenderName
SenderName string

Sender Name

TemplateID
TemplateID integer

Template ID

Title
Title string

Title

ContactsListID
ContactsListID string

Contacts List ID

ContactsListAlt
ContactsListAlt string

Contacts List Alt

Locale
Locale True string

Locale

SegmentationID
SegmentationID integer

Segmentation ID

SegmentationAlt
SegmentationAlt string

Segmentation Alt

Sender
Sender string

Sender

SenderEmail
SenderEmail string

Sender Email

Subject
Subject True string

Subject

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of CampaignDraftResponse

Data

Total
Total integer

Total

Create Contact

Add a new unique contact to your global contact list and select its exclusion status

Parameters

Name Key Required Type Description
IsExcludedFromCampaigns
IsExcludedFromCampaigns string

Indicates whether the contact is added to the exclusion list for campaigns or not

Name
Name string

User-selected name for this contact

Email
Email True string

Contact email address

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of ContactResponse

Data

Total
Total integer

Total

Create Contact List

Create a new contact list

Parameters

Name Key Required Type Description
Name
Name True string

User-specified name for this contact list (must be unique)

IsDeleted
IsDeleted boolean

When true, the contact list will be marked as Deleted

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of ContactsListResponse

Data

Total
Total integer

Total

Delete Contact List

Delete a contact list

Parameters

Name Key Required Type Description
List ID
list_ID True string

List ID

Returns

Get Campaign Draft By ID

Get a specific campaign draft and its configuration details

Parameters

Name Key Required Type Description
Draft ID
draft_ID True integer

Unique numeric ID of the campaign draft you want to retrieve.

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of CampaignDraftResponse

Data

Total
Total integer

Total

Get Campaign Overview

Get general details and stats for all drafts, AB Testing objects and/or sent campaigns

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of object

Data

ClickedCount
Data.ClickedCount integer

Clicked Count

DeliveredCount
Data.DeliveredCount integer

Delivered Count

EditMode
Data.EditMode string

Edit Mode

EditType
Data.EditType string

Edit Type

ID
Data.ID integer

ID

IDType
Data.IDType string

ID Type

OpenedCount
Data.OpenedCount integer

Opened Count

ProcessedCount
Data.ProcessedCount integer

Processed Count

SendTimeStart
Data.SendTimeStart integer

Send Time Start

Starred
Data.Starred boolean

Starred

Status
Data.Status integer

Status

Subject
Data.Subject string

Subject

Title
Data.Title string

Title

Total
Total integer

Total

Get Campaigns Draft

Get all campaign drafts and their configuration

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of CampaignDraftResponse

Data

Total
Total integer

Total

Get Contact By ID

Retrieve a specific contact

Parameters

Name Key Required Type Description
Contact ID
contact_ID True string

Unique numeric ID of the contact you want to retrieve

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of ContactResponse

Data

Total
Total integer

Total

Get Contact Data By ID

Retrieve all properties and respective values associated with a specific contact

Parameters

Name Key Required Type Description
Contact ID
contactID True integer

Unique numeric ID for the contact, whose properties you want to retriev

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of ContactDataResponse

Data

Total
Total integer

Total

Get Contact List By ID

Retrieve details for a specific contact list - name, subscriber count, creation timestamp, deletion status.

Parameters

Name Key Required Type Description
Unique numeric ID
list_ID True string

Unique numeric ID assigned to this contact list.

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of ContactsListResponse

Data

Total
Total integer

Total

Get Contact Lists

Retrieve details for all contact lists - name, subscriber count, creation timestamp, deletion status.

Parameters

Name Key Required Type Description
Address
Address string

Retrieves only the contact list with the specified unique address created by Mailjet.

Exclude ID
ExcludeID integer

Excludes the contact list with specified ID from the response.

Is Deleted ?
IsDeleted boolean

When true, will retrieve only deleted lists. When false, will retrieve lists that are not deleted.

Name
Name string

Retrieves only the list with the specified user-selected Name.

Limit
Limit integer

Limit the response to a select number of returned objects.

Offset
OffSet integer

Retrieve a list of objects starting from a certain offset.

Count Only
countOnly boolean

Return the count rows only or not.

Sort
Sort string

Specify a property name for this query parameter to sort the objects in Data.

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of ContactsListResponse

Data

Total
Total integer

Total

Get Contacts

Retrieve a list of all contacts. Includes information about contact status and creation / activity timestamps

Parameters

Name Key Required Type Description
Campaign
Campaign integer

Retrieves only contacts targeted by this Campaign ID

ContactsList
ContactsList integer

Retrieves only contacts that are part of this Contact List ID

IsExcludedFromCampaigns
IsExcludedFromCampaigns boolean

Will retrieve only contacts that have been added to the exclusion list for marketing emails

Limit
Limit integer

Limit the response to a select number of returned objects

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of ContactResponse

Data

Total
Total integer

Total

Get Contacts Data

Get information on all contacts and the property values associated with them

Parameters

Name Key Required Type Description
Campaign
Campaign integer

Retrieves a list of contact property values only for the contacts, which received emails from this Campaign ID

Contact Email
ContactEmail string

Retrieves a list of contact property values only for the contact with this email address

Contact List ID
ContactsList integer

Retrieves a list of contact property values only for the contacts that are part of this contact list ID

Fields
Fields string

Multiple properties can be specified by separating them with commas

Last Activity At
LastActivityAt string

Retrieves a list of contact property values only for the contacts

Limit
Limit integer

Limit the response to a select number of returned objects

Offset
OffSet integer

Retrieve a list of objects starting from a certain offset

Count Only
countOnly boolean

Return count only.

Sort
Sort string

Specify a property name for this query parameter to sort the objects in Data

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of ContactDataResponse

Data

Total
Total integer

Total

Get Contacts Statistics

Retrieve a list of overall aggregated delivery and engagement statistics, grouped by contact

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of object

Data

BlockedCount
Data.BlockedCount integer

Blocked Count

BouncedCount
Data.BouncedCount integer

Bounced Count

ClickedCount
Data.ClickedCount integer

Clicked Count

ContactID
Data.ContactID integer

Contact ID

DeferredCount
Data.DeferredCount integer

Deferred Count

DeliveredCount
Data.DeliveredCount integer

Delivered Count

HardbouncedCount
Data.HardbouncedCount integer

Hardbounced Count

LastActivityAt
Data.LastActivityAt date-time

Last Activity At

MarketingContacts
Data.MarketingContacts integer

Marketing Contacts

OpenedCount
Data.OpenedCount integer

Opened Count

ProcessedCount
Data.ProcessedCount integer

Processed Count

QueuedCount
Data.QueuedCount integer

Queued Count

SoftbouncedCount
Data.SoftbouncedCount integer

Soft bounced Count

SpamComplaintCount
Data.SpamComplaintCount integer

Spam Complaint Count

UnsubscribedCount
Data.UnsubscribedCount integer

Unsubscribed Count

UserMarketingContacts
Data.UserMarketingContacts integer

User Marketing Contacts

WorkFlowExitedCount
Data.WorkFlowExitedCount integer

WorkFlow Exited Count

Total
Total integer

Total

Get Messages

Get a list of messages with specific information on the type of content, tracking, sending and delivery

Parameters

Name Key Required Type Description
Contact
Contact integer

Retrieves only messages sent to the specified Contact ID

CustomID
CustomID integer

Retrieves only messages tagged with the specified CustomID

Destination
Destination integer

Retrieves only messages sent to the specified Destination ID

FromTS
FromTS date-time

Retrieves only messages sent after the specified timestamp

Limit
Limit integer

Limit the response to a select number of returned objects

FromType
FromType integer
  • 1 - Transactional
  • 2 - Marketing
  • 3 - Unknown

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of MessageResponse

Data

Total
Total integer

Total

Get Messages Information

Retrieve sending/size/spam information about all messages

Parameters

Name Key Required Type Description
CampaignID
CampaignID integer

Retrieves information only about messages that are part of this campaign

ContactsList
ContactsList integer

Retrieves information only about messages that were sent to this contact list

CustomCampaign
CustomCampaign integer

Retrieves information only about messages that are part of a campaign with the specified Custom ID

From
From string

Retrieves information only about messages sent from the specified sender email address

FromDomain
FromDomain string

Retrieves information only about messages sent from the specified sender domain

FromID
FromID integer

Retrieves information only about messages sent from the specified sender ID

FromTS
FromTS date-time

Retrieves only messages sent after the specified timestamp

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of MessageInformationResponse

Data

Total
Total integer

Total

Send Email v3

Send an email message via Send API v3

Parameters

Name Key Required Type Description
From Email
FromEmail True string

From Email

From Name
FromName string

From Name

Sender
Sender boolean

Sender

Recipent Email
Email string

Email

Recipent Name
Name string

Name

To Email
To True string

To Email

Cc Email
Cc string

Cc Email

Bcc Email
Bcc string

Bcc Email

Subject
Subject string

The email subject line

Text-part
Text-part string

Text-part

Html-part
Html-part string

Html-part

Filename
Filename string

The full name of the file (including the file extension)

Content-type
Content-type string

Defines the type of content being sent out using a MIME type

Content
Content string

Base64 encoded content of the attached file

Filename
Filename string

Filename

Content-type
Content-type string

Content-type

Content
Content string

Content

Returns

Name Path Type Description
Sent
Sent array of object

Sent

Email
Sent.Email string

Email

MessageID
Sent.MessageID integer

Message ID

MessageUUID
Sent.MessageUUID string

Message UUID

Send Email v3.1

Send an email message via Send API v3.1

Parameters

Name Key Required Type Description
From Email
Email True string

The From email address

From Name
Name string

The name of the sender

To Email
Email string

The email address of the recipient

To Name
Name string

The name of the recipient

Sender Email
Email string

The email address used to send the message

Sender Name
Name string

User-selected name for the Sender email address

ReplyTo Email
Email string

ReplyTo Email

ReplyTo Name
Name string

ReplyTo Name

Cc Email
Email string

Cc Email

Cc Name
Name string

Cc Name

Bcc Email
Email string

Bcc Email

Bcc Name
Name string

Bcc Name

Subject
Subject string

The email subject line.

TextPart
TextPart string

Provides the Text part of the message

HTMLPart
HTMLPart string

Provides the HTML part of the message.

TemplateID
TemplateID integer

Unique numeric ID of the template to be used as email content.

Filename
Filename string

The full name of the file (including the file extension)

Content-type
Content-type string

Defines the type of content being sent out using a MIME type

Content
Base64Content string

Base64 encoded content of the attached file

SandboxMode
SandboxMode boolean

Sandbox Mode

AdvanceErrorHandling
AdvanceErrorHandling boolean

Advance Error Handling

Returns

Name Path Type Description
Messages
Messages array of object

Messages

Status
Messages.Status string

Status

Errors
Messages.Errors array of object

Errors

ErrorIdentifier
Messages.Errors.ErrorIdentifier string

Error Identifier

ErrorCode
Messages.Errors.ErrorCode string

Error Code

StatusCode
Messages.Errors.StatusCode integer

Status Code

ErrorMessage
Messages.Errors.ErrorMessage string

Error Message

ErrorRelatedTo
Messages.Errors.ErrorRelatedTo string

Error Related To

CustomID
Messages.CustomID string

Custom ID

To
Messages.To array of object

To

Email
Messages.To.Email string

Email

MessageUUID
Messages.To.MessageUUID string

Message UUID

MessageID
Messages.To.MessageID integer

Message ID

MessageHref
Messages.To.MessageHref string

Message Href

Cc
Messages.Cc array of object

Cc

Email
Messages.Cc.Email string

Email

MessageUUID
Messages.Cc.MessageUUID string

Message UUID

MessageID
Messages.Cc.MessageID integer

Message ID

MessageHref
Messages.Cc.MessageHref string

Message Href

Bcc
Messages.Bcc array of object

Bcc

Email
Messages.Bcc.Email string

Email

MessageUUID
Messages.Bcc.MessageUUID string

Message UUID

MessageID
Messages.Bcc.MessageID integer

Message ID

MessageHref
Messages.Bcc.MessageHref string

Message Href

Update Campaign Draft

Update an existing campaign draft

Parameters

Name Key Required Type Description
Draft ID
draft_ID True integer

Unique numeric ID of the campaign draft you want to update

Content-Type
Content-Type string

Content-Type

Current
Current integer

Current

Edit Mode
EditMode string

Edit mode for the campaign draft.

IsStarred
IsStarred boolean

Is Starred

IsTextPartIncluded
IsTextPartIncluded boolean

Is Text Part Included

ReplyEmail
ReplyEmail string

Reply Email

SenderName
SenderName string

Sender Name

TemplateID
TemplateID integer

Template ID

Title
Title string

Title

ContactsListID
ContactsListID string

Contacts List ID

ContactsListAlt
ContactsListAlt string

Contacts List Alt

Locale
Locale True string

Locale

SegmentationID
SegmentationID integer

Segmentation ID

SegmentationAlt
SegmentationAlt string

Segmentation Alt

Sender
Sender string

Sender

SenderEmail
SenderEmail string

Sender Email

Subject
Subject True string

Subject

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of CampaignDraftResponse

Data

Total
Total integer

Total

Update Contact

Update the user-given name and exclusion status of a specific contact

Parameters

Name Key Required Type Description
Contact ID
contact_ID True string

Unique numeric ID of the contact you want to update

IsExcludedFromCampaigns
IsExcludedFromCampaigns boolean

Indicates whether the contact is added to the exclusion list for campaigns or not

Name
Name string

User-selected name for this contact

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of ContactResponse

Data

Total
Total integer

Total

Update Contact List

Update a specific contact list by changing its name and / or deletion status

Parameters

Name Key Required Type Description
List ID
list_ID True string

Unique numeric ID assigned to this contact list

Name
Name True string

User-specified name for this contact list (must be unique)

IsDeleted
IsDeleted boolean

When true, the contact list will be marked as Deleted

Returns

Name Path Type Description
Count
Count integer

Count

Data
Data array of ContactsListResponse

Data

Total
Total integer

Total

Definitions

MessageResponse

Name Path Type Description
ArrivedAt
ArrivedAt string

Arrived At

AttachmentCount
AttachmentCount integer

Attachment Count

AttemptCount
AttemptCount integer

Attempt Count

CampaignID
CampaignID integer

Campaign ID

ContactAlt
ContactAlt string

Contact Alt

ContactID
ContactID integer

Contact ID

Delay
Delay number

Delay

DestinationID
DestinationID integer

Destination ID

FilterTime
FilterTime integer

Filter Time

ID
ID integer

ID

IsClickTracked
IsClickTracked boolean

Is Click Tracked

IsHTMLPartIncluded
IsHTMLPartIncluded boolean

Is HTML Part Included

IsOpenTracked
IsOpenTracked boolean

Is Open Tracked

IsTextPartIncluded
IsTextPartIncluded boolean

Is Text Part Included

IsUnsubTracked
IsUnsubTracked boolean

Is Unsubscription Tracked

MessageSize
MessageSize integer

Message Size

SenderID
SenderID integer

Sender ID

SpamassassinScore
SpamassassinScore number

Spamassassin Score

SpamassRules
SpamassRules string

Spamass Rules

StateID
StateID integer

State ID

StatePermanent
StatePermanent boolean

State Permanent

Status
Status string

Status

Subject
Subject string

Subject

UUID
UUID string

UUID

MessageInformationResponse

Name Path Type Description
CampaignID
CampaignID integer

Campaign ID

ClickTrackedCount
ClickTrackedCount integer

Click Tracked Count

ContactID
ContactID integer

Contact ID

CreatedAt
CreatedAt date-time

Created At

ID
ID integer

ID

MessageSize
MessageSize integer

Message Size

OpenTrackedCount
OpenTrackedCount integer

Open Tracked Count

QueuedCount
QueuedCount integer

Queued Count

SendEndAt
SendEndAt string

Send End At

SentCount
SentCount integer

Sent Count

SpamAssassinScore
SpamAssassinScore number

Spam Assassin Score

ContactResponse

Name Path Type Description
IsExcludedFromCampaigns
IsExcludedFromCampaigns boolean

Is Excluded FromCampaigns

Name
Name string

Name

CreatedAt
CreatedAt date-time

Created At

DeliveredCount
DeliveredCount integer

Delivered Count

Email
Email string

Email

ExclusionFromCampaignsUpdatedAt
ExclusionFromCampaignsUpdatedAt string

Exclusion From Campaigns Updated At

ID
ID integer

ID

IsOptInPending
IsOptInPending boolean

Is OptIn Pending

IsSpamComplaining
IsSpamComplaining boolean

Is Spam Complaining

LastActivityAt
LastActivityAt date-time

Last Activity At

LastUpdateAt
LastUpdateAt date-time

Last Update At

ContactsListResponse

Name Path Type Description
Name
Name string

Name

Address
Address string

Address

CreatedAt
CreatedAt date-time

Created At

ID
ID integer

ID

SubscriberCount
SubscriberCount integer

Subscriber Count

CampaignDraftResponse

Name Path Type Description
AXFraction
AXFraction integer

AX Fraction

AXFractionName
AXFractionName string

AX Fraction Name

AXTesting
AXTesting string

AX Testing

Current
Current integer

Current

EditMode
EditMode string

Edit Mode

IsStarred
IsStarred boolean

Is Starred

IsTextPartIncluded
IsTextPartIncluded boolean

Is TextPart Included

ReplyEmail
ReplyEmail string

Reply Email

SenderName
SenderName string

Sender Name

TemplateID
TemplateID integer

Template ID

Title
Title string

Title

CampaignID
CampaignID integer

Campaign ID

ContactsListID
ContactsListID integer

Contacts List ID

CreatedAt
CreatedAt date-time

Created At

DeliveredAt
DeliveredAt date-time

Delivered At

ID
ID integer

ID

Locale
Locale string

Locale

ModifiedAt
ModifiedAt date-time

Modified At

Preset
Preset string

Preset

SegmentationID
SegmentationID integer

Segmentation ID

Sender
Sender string

Sender

SenderEmail
SenderEmail string

Sender Email

Status
Status integer

Status

Subject
Subject string

Subject

Url
Url string

Url

Used
Used boolean

Used

ContactDataResponse

Name Path Type Description
ContactID
ContactID integer

Unique numeric ID for this contact

Data
Data array of

A JSON array containing contact properties and their values

ID
ID integer

Unique numeric ID for this contact's Data object

MethodCollection
MethodCollection string

MethodCollection