Overview

Below you will find a list of all available resources in the Mailjet API to send and manage email messages.

Send Emails

Send API v3 and v3.1 are part of Mailjet's transactional messaging suite. Send API v3.1 gives more detailed feedback information on your sendings, while Send API v3 gives you a higher sending limit per single API call.

For information on sending email campaigns to a list of contacts, please see the Campaigns section.

post

Send an email message via Send API v3

post

Send an email message via Send API v3.1

Messages

Every time you send an email via Mailjet, a new message object is created. The resources below help you retrieve details about these messages - sending time, delivery and contact engagement info, recipients, message size, etc.

get

Get detailed information on all processed messages

get

Get detailed information on a specific processed message

get

Get the event history for a specific message

get

Retrieve sending / size / spam information about all messages

get

Retrieve sending / size / spam information about a specific message ID

get

Get a list of event summaries for all messages

get

Get an event summary for a specific message

Contacts

Contact

Contact objects represent the email addresses you intend to send (or have already sent) messages to.

post

Create a new contact

get

Get a list of all contacts

get

Get a specific contact

put

Update a specific contact

Contact List

Contact List objects help you organize your contacts into lists. Every time you send a campaign you must select a recipient contact list. Segmentation can help you target a portion of that list.

post

Create a new contact list

get

Retrieve general details for all contact lists

get

Retrieve information on a specific contact list

put

Update a specific contact list

delete

Delete a contact list

Bulk Contact Management

Managing contacts is a tedious task if you need to do a call for each contact separately. Use the resources below to add, remove or unsubscribe multiple contacts with a single call.

post

Add, remove or unsubscribe a list of contacts to/from a selection of contact lists

get

Monitor a submitted upload / update request for multiple contacts

post

Add, unsubscribe or remove the contacts present in a list to / from another list

get

Monitor a submitted upload / update request for contacts from one list to another

post

Add, remove or unsubscribe a list of contacts to/from a specific contact list

get

Monitor a submitted upload / update request for multiple contacts into a specific contact list

post

Use an uploaded CSV list of contacts to manage their presence and subscription status in a contact list

get

View the status of a CSV import job

put

Update or abort a contact CSV import job in progress

Contact Properties

Contact properties allow you to store details about your subscribers - e.g. a name, age or location. They allow you to personalize the content of the emails you are sending, and help you with targeting a specific segment of customers within a contact list.

Use the resources below to manage the available contact properties (/contactmetadata) and the values of those properties for each contact (/contactdata).

post

Create the contact property values relating to a specific contact

get

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

get

Get the contact property values relating to a specific contact

put

Update the contact property values relating to a specific contact

delete

Delete all contact property values relating to a specific contact

post

Create a new contact property

get

Get information on all contact properties

get

Get information on a specific contact property

put

Update the settings of an existing contact property

delete

Delete an existing contact property

Subscriptions

Contacts need to be subscribed to a contact list, in order to receive marketing emails directed to the respective list. The resources below help you manage the subscription status of your contacts.

get

Get all contact lists for a specific contact

post

Add, remove or unsubscribe a contact to/from a selection of contact lists

get

Get info on all signup requests via a subscription widget

get

Get info on a specific signup request via a subscription widget

post

Manage a single contact subscription to a specific contact list

post

Create a new list recipient

get

Get details on all list recipients

get

Get details for a specific list recipient

put

Update the subscription status of a list recipient

delete

Delete a list recipient

Campaigns

Drafts

To send a marketing campaign, you first need to create a draft object. In that object you specify the senders, recipients, contents, etc. Use the resources below to manage your drafts, as well as test, schedule and send them. Once a draft is sent, it automatically creates a campaign object.

post

Create a new campaign draft

get

Get all campaign drafts and their configuration

get

Get a specific campaign draft and its configuration details

put

Update an existing campaign draft

post

Manage the content of your campaign draft email

get

Retrieve the content of your campaign draft email

post

Schedule the sending of a campaign draft

get

Retrieve the sending schedule of a campaign draft

put

Update the sending schedule of a campaign draft

delete

Cancel the scheduled sending of a campaign draft

post

Send a campaign draft immediately

get

View the sending status of a campaign draft

post

Send a test email for a specified campaign draft

post

Create a new newsletter

get

Get all newsletters and their configuration details

get

Get a specific newsletter and its configuration details

put

Update an existing newsletter

post

Manage the content of your newsletter email

get

Get the content of your newsletter email

put

Update the contents of a newsletter email

delete

Delete the contents of a newsletter email

post

Schedule the sending of a newsletter

get

Retrieve the sending schedule of a newsletter

put

Update the schedule for sending a newsletter

delete

Cancel the scheduled sending of a newsletter

post

Send a newsletter immediately

get

View the sending status of a newsletter

post

Send a test email for a specified newsletter

Sent Campaigns

When you send a campaign draft, a new campaign object is automatically created. Use the resources below to retrieve information about campaigns, mark selected campaigns as starred or delete them.

get

Get detailed information about all campaigns

get

Get detailed information about a specific campaign

put

Delete a campaign or mark it as starred

Segmentation

Segmentation is an extremely useful tool used to target a specific group of customers with a dedicated campaign. Create segments based on contact properties or the contact activity (opens, clicks). Segmentation helps you focus your campaigns on specific demographics, create re-engagement campaigns, etc.

The resources below help you manage your segmentation formulas.

post

Create a new contact segmentation formula

get

Get a list of all existing segments

get

Get an existing contact segmentation formula

put

Update an existing contact segmentation formula

delete

Delete an existing contact segmentation formula

Templates

Templates are essential building blocks for your campaigns, transactional emails or automation workflows. With the resources below you can manage your templates and their content.

post

Create an email template

get

Get all email templates

get

Retrieve the configuration settings for a specific template

put

Update the configuration settings of an email template

delete

Delete an email template

post

Create the contents of an email template

get

Get the contents of an email template

put

Update the contents of an email template

Statistics

The statistics resources provide a read-only access to your Mailjet statistics. The different endpoints will help you extract metrics groups based on different factors, such as campaigns, contacts, lists, recipient domain providers, link clicks, etc.

Note: Use /statcounters to retrieve your key performance statistics for specific campaigns, contact lists or your API Key as a whole. See the Statistics section of our Email API Guide for more information.

get

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

get

Get information about a specific draft, AB Testing object or sent campaign

get

Get aggregated statistics, grouped by contact

get

Get aggregated statistics for a specific contact

get

Retrieve aggregated open and click statistics, grouped by recipient country

get

Get aggregated statistics for all clicked links in a campaign

get

Get aggregated statistics, grouped by list recipient

get

Get aggregated statistics for a specific list recipient

get

Retrieve statistics, aggregated by recipient's Email Service Provider (ESP)

get

Get aggregated statistics, grouped by sender

get

Get aggregated statistics for a specific sender

get

Get message-based or event-based aggregated statistics for a specific campaign, contact list or API Key

get

Get aggregated statistics for all clicked links

get

Get open or click counts, grouped by web browser

get

Get total aggregated statistics for an API Key

get

Get information on the evolution of Open, Click, Spam and / or Unsubscribe events for selected campaigns

get

Get information on the evolution of Open, Click, Spam and / or Unsubscribe events for a specific campaign

get

Get delivery and engagement statistics for all campaigns

get

Get delivery and engagement statistics for a specific campaign

get

Get aggregated statistics, grouped by recipient domain

get

Get information on the evolution of statistics by grouping them by time intervals

get

Get subscriber information and aggregated statistics for all contact lists

get

Get subscriber information and aggregated statistics for a specific contact list

get

Get message-based aggregated statistics

get

Get aggregated statistics for a specific message

get

Get aggregated statistics for opened messages

Message Events

The resources below help you you extract details about specific delivery and engagement events - opens, clicks, email bounces, etc.

get

Get a list of all bounce events

get

Get details for a specific bounce event

get

Get a list of all click events

get

Get a list of all open events

get

Retrieve open event details for a specific message

Webhook

The resources below helps you track email delivery and engagement events and forward the information to a webhook URL of your choice. You can use this data to create additional workflows - react to spam reports, identify bounced email addresses, sync unsubscribed contacts, etc.

post

Add a new callback URL

get

Get a list of all callback URLs

get

Get the configuration of a specific callback URL

put

Update the configuration of an existing callback URL

delete

Delete an existing callback URL

Parse

The Mailjet Parse API can parse the content, header and/or attachments of incoming emails and deliver it to a webhook of your choice. This makes the processing of inbound messages much easier, since all you have left to do is save the info to your CRM or database.

post

Create a new parseroute instance

get

Get a list of all parseroute instances

get

Get the configuration details for a specific parseroute resource

put

Update an existing parseroute instance

delete

Delete an existing parseroute instance

Sender Addresses and Domains

Sender

Senders objects are used to select the From email address for the emails you are sending. Use the resources below to manage and validate your senders.

post

Create a new sender email address or domain

get

Get a list of all existing sender email addresses and domains

get

Retrieve details on a specific sender email address or domain

put

Update an existing sender email address or domain

delete

Delete an existing sender email address or domain

post

Validate a sender email address or domain

Metasender

Metasender objects are senders, which can be used on the master account as well as all sub-account API Keys. Use the resources below to manage your metasenders.

post

Create a new metasender

get

Get a list of all metasenders

get

Get a specific metasender

put

Update and existing metasender

DNS

Whenever you register a new sender or metasender address with a new domain name, a new DNS object is created for this domain. Use the resources below to retrieve the DNS records you need to complete a successful domain validation and SPF / DKIM authentication.

get

Get the SPF and DKIM settings for all sender domains

get

Get the SPF and DKIM settings for a specific sender domain

post

Perform a DNS validation of a sender domain

Settings

API Key Configuration

Use the resources below to manage your API Keys, as well as the access rights assigned to other users.

post

Create a new sub-account API Key

get

Get all API Keys and their configuration settings

get

Get the configuration settings of a specific API Key

put

Update an existing API Key

Account Settings

Use the resources below to update your Mailjet profile and user information.

get

Retrieve your profile information

put

Update your profile information

get

Get general information on your user settings and activity

put

Update the settings of your User ID