The Mailjet connector lets your AI agent act in each user's Mailjet account. Each user connects their own Mailjet API key and secret once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 63 tools.
- Tools
- 63
- What they doRead · write · destructive
- 31 · 26 · 631 read26 write6 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Mailjet connection
In AgentKit > Connections, create a Mailjet connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolmailjet_campaign_draft_getRetrieve one campaign draft.Read-onlyGet Campaign Draft
Retrieve one campaign draft. Returns Data with ID, Title, Subject, ContactsListID, SegmentationID, SenderEmail, SenderName, Locale, TemplateID and Status.
Inputs
draft_idintegerrequired- Campaign draft ID. Example: 54321
mailjet_campaign_draft_status_getGet the sending status of a campaign draft.Read-onlyGet Campaign Draft Status
Get the sending status of a campaign draft. Returns Data with Status (for example programmed, sent or AXCanceled).
Inputs
draft_idintegerrequired- Campaign draft ID. Example: 54321
mailjet_campaign_drafts_listList marketing campaign drafts.Read-onlyList Campaign Drafts
List marketing campaign drafts. Returns Data, an array with ID, Title, Subject, ContactsListID, SenderEmail, Status, DeliveredAt and CreatedAt.
Inputs
campaigninteger- Retrieves only the campaign draft linked to the specified Campaign ID. Example: 123
contacts_listinteger- Retrieves only the campaign drafts linked to the specified contact list ID. Example: 123
delivered_atstring- Retrieves only the campaign drafts, which were delivered at the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Example: 2026-11-01T00:00:00
edit_modestring- Retrieves only campaign drafts, whose email templates were edited with the specified edit tool. Possible values:; tool2 - Passport drag-and-drop template editor; html2 - HTML editor in Passport; mjml - MJML editor in Passport. Example: tool2
is_archivedboolean- When true, will return only archived campaign drafts. When false, archived campaign drafts will be excluded from the response. Example: true
is_campaignboolean- Only retrieves campaigndraft resources for which IsCampaign equals the specified value. Example: true
is_deletedboolean- When true, will return only deleted campaign drafts. When false, deleted drafts will be excluded from the response. Example: true
is_handledboolean- Only retrieves campaigndraft resources for which IsHandled equals the specified value. Example: true
is_starredboolean- When true, will return only starred campaign drafts. When false, starred drafts will be excluded from the response. Example: true
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
modifiedboolean- When true, will return only campaign drafts that have been modified after their creation. When false, only non-modified drafts will be returned. Note: All campaign drafts created within the Mailjet app are marked as Modified immediately after creation, while ones created via the API are not. Example: true
news_letter_templateinteger- Only retrieves campaigndraft resources for which NewsLetterTemplate equals the specified value. Example: 123
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
segmentationinteger- Retrieves only campaign drafts, which use the specified segmentation ID. Example: 123
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
statusinteger- Retrieves only campaign drafts with the specified campaign status ID. Possible values:; -3 - AXCanceled; -2 - Deleted; -1 - Archived; 0 - Draft; 1 - Programmed (scheduled); 2 - Sent; 3 - AXTested (AB Testing versions sent, but winning version not selected yet); 4 - AXSelected (AB Testing winning version selected and sent) Example: -3
subjectstring- Retrieves only campaign drafts with the specified Subject line. Example: Hello from Acme
templateinteger- Retrieves only campaign drafts which use the specified Template ID. Example: 123
mailjet_campaign_getRetrieve one sent campaign by ID.Read-onlyGet Campaign
Retrieve one sent campaign by ID. Returns Data with ID, Subject, FromEmail, ListID, NewsLetterID, SendStartAt, SendEndAt and Status.
Inputs
campaign_idintegerrequired- Campaign ID, or mj.nl=<newsletter ID>, or the CustomCampaign name. Example: 7654321
mailjet_campaign_overview_listList campaigns (newsletters, automation and transactional campaigns) with their send date and headline statistics.Read-onlyList Campaign Overviews
List campaigns (newsletters, automation and transactional campaigns) with their send date and headline statistics. Returns Data, an array with ID, IDType, Title, Subject, SendTimeStart, DeliveredCount, OpenedCount, ClickedCount and Status.
Inputs
allboolean- When true, will retrieve all campaigns, drafts and AB Testing objects that are not deleted (IsDeleted!=0). When false, both deleted and non-deleted ones will be retrieved. Default value: false Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True. Example: true
archivedboolean- When true, will retrieve all archived campaigns, drafts and AB Testing objects. When false, archived ones are excluded from the response. Default value: false Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True. Example: true
draftsboolean- When true, will retrieve all drafts (and AB Testing objects in Draft mode). When false, both drafts and sent campaigns / AB Testing objects will be retrieved. Default value: false Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True. Example: true
idinteger- Retrieves only the draft, sent campaign or AB testing object linked to this unique numeric ID. Note: Mandatory, when the ID query parameter is used. Example: 123
id_typestring- Retrieves only objects of the specified type:; Campaign - Sent campaign; AX - AB Testing object; NL - Draft Note: Mandatory, when the ID query parameter is used. Example: Campaign
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
programmedboolean- When true, will retrieve only drafts that are scheduled for sending - i.e. with Programmed status. When false, both programmed and draft / sent / deleted objects will be retrieved. Default value: false Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True. Example: true
sentboolean- When true, will retrieve only sent campaigns. When false, both sent and not sent objects will be retrieved. Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True. Example: true
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
starredboolean- When true, will retrieve only starred campaigns, drafts and AB Testing objects. When false, both starred and non-starred ones will be retrieved. Default value: false Note: You cannot set more than one status query parameter (All, Archived, Drafts, Programmed, Sent, Starred) to True. Example: true
subjectstring- Retrieves only campaigns, drafts and AB Testing objects with the specified subject line. Example: Hello from Acme
mailjet_campaigns_listList sent campaigns (marketing and transactional), filtered by sender, list, period or status.Read-onlyList Campaigns
List sent campaigns (marketing and transactional), filtered by sender, list, period or status. Returns Data, an array with ID, Subject, FromEmail, ListID, NewsLetterID, SendStartAt, SendEndAt, Status and CustomValue.
Inputs
campaign_idinteger- Retrieves only the campaign details for the specified Campaign ID. Example: 123
contacts_list_idinteger- Retrieves only details for campaigns sent to the specified Contact List ID. Example: 123
custom_campaignstring- Retrieves only details for the campaign with the specified custom value assigned to it. Example: november-newsletter
fromstring- Retrieves only details for campaigns, which used the specified sender email address. Example: orders@example.com
from_domainstring- Retrieves only details for campaigns, which used the specified sender email domain. Example: example.com
from_idinteger- Retrieve only details for campaigns, which used the specified sender ID. Example: 123
from_tsstring- Retrieves only details for campaigns sent after the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Example: 2026-11-01T00:00:00Z
from_typeinteger- Retrieves only details for campaigns of the specified type:; 1 - Transactional; 2 - Marketing; 3 - Unknown. Example: 1
is_deletedboolean- When true, only details for deleted campaigns will be returned. When false, deleted campaigns will be excluded from the response. Example: true
is_newsletter_toolboolean- When true, will return only details for campaigns created by the Newsletter tool (legacy template builder). When false, newsletter campaigns will be excluded from the response. Example: true
is_starredboolean- When true, will return only details for campaigns marked as starred. When false, starred campaigns will be excluded from the response. Example: true
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
periodstring- Retrieves only details for campaigns sent between the start of the selected period and the current timestamp.; Day - since the start of the current day; Week - since the start of the current week; Month - since the start of the current month; Year - since the start of the current year. Example: 2026-11-01T00:00:00
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
to_tsstring- Retrieves only details for campaigns sent before this timestamp. Example: 2026-11-01T00:00:00Z
workflow_idinteger- Retrieves only details for campaigns that were triggered by this automation workflow ID. Example: 123
mailjet_contact_data_getRetrieve a contact's custom property values (contact data).Read-onlyGet Contact Properties
Retrieve a contact's custom property values (contact data). Returns Data with ContactID and Data, an array of Name and Value pairs.
Inputs
contact_idstringrequired- Contact ID or email address. Example: jane@example.com
mailjet_contact_getRetrieve one contact by ID or email address.Read-onlyGet Contact
Retrieve one contact by ID or email address. Returns Data with ID, Email, Name, CreatedAt, IsExcludedFromCampaigns, IsOptInPending and LastActivityAt. Use mailjet_contact_data_get for the contact's custom properties.
Inputs
contact_idstringrequired- Contact ID or email address. Example: jane@example.com
mailjet_contact_list_bulk_job_getCheck the status of a bulk contact job started with mailjet_contact_list_bulk_manage.Read-onlyGet Bulk Contact Job
Check the status of a bulk contact job started with mailjet_contact_list_bulk_manage. Returns Data with Status (for example Completed), Count, ErrorFile and JobStart/JobEnd times.
Inputs
job_idintegerrequired- Job ID returned when the job was started. Example: 987654
list_idintegerrequired- Contact list ID. Example: 12345
mailjet_contact_list_getRetrieve one contact list.Read-onlyGet Contact List
Retrieve one contact list. Returns Data with ID, Name, Address, SubscriberCount, IsDeleted and CreatedAt.
Inputs
list_idintegerrequired- Contact list ID. Example: 12345
mailjet_contact_lists_get_for_contactList the contact lists one contact belongs to, with its subscription status in each.Read-onlyGet Contact's Lists
List the contact lists one contact belongs to, with its subscription status in each. Returns Data, an array with ListID, IsUnsub, IsActive and SubscribedAt.
Inputs
contact_idstringrequired- Contact ID or email address. Example: jane@example.com
mailjet_contact_lists_listList the contact lists in the account.Read-onlyList Contact Lists
List the contact lists in the account. Returns Data, an array with ID, Name, Address, SubscriberCount, IsDeleted and CreatedAt, plus Count and Total.
Inputs
addressstring- Retrieves only the contact list with the specified unique address created by Mailjet. This address which can be used only via Mailjet's SMTP server to reach all contacts in it. It is displayed in the Address property of the list. The full email will be {Address}@lists.mailjet.com. Example: orders@example.com
exclude_idinteger- Excludes the contact list with specified ID from the response. Example: 123
is_deletedboolean- When true, will retrieve only deleted lists. When false, will retrieve lists that are not deleted. Example: true
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
namestring- Retrieves only the list with the specified user-selected Name. Example: Newsletter
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
mailjet_contact_properties_listList the custom contact properties (contact metadata) defined in the account.Read-onlyList Contact Properties
List the custom contact properties (contact metadata) defined in the account. Returns Data, an array with ID, Name, Datatype (str, int, float, bool, datetime) and NameSpace (static or historic).
Inputs
data_typestring- Retrieves only properties with the respective data type:; str - string; int - integer; float - float / number; bool - boolean; datetime - datetime (Unix Timestamp or RFC 3339) Example: 2026-11-01T00:00:00
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
namespacestring- Retrieves only properties with the respective namespace:; static - Can keep only 1 value. Each change to the value of the property for a contact overwrites the previously selected value. The values are saved in a contactdata object.; historic - Each change to the value of the property creates a record in a new contacthistorydata object, saving the property value and a timestamp of when it was submitted. Example: 2026-11-01T00:00:00
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
mailjet_contact_statistics_listList per-contact message statistics (delivered, opened, clicked, bounced, spam, unsubscribed counts).Read-onlyList Contact Statistics
List per-contact message statistics (delivered, opened, clicked, bounced, spam, unsubscribed counts). Returns Data, an array with ContactID and the counters, plus Count and Total.
Inputs
blockedboolean- When true, will retrieve statistics only for contacts that have at least one blocked message. When false, contacts with blocked messages will be excluded from the response. Example: true
bouncedboolean- When true, will retrieve statistics only for contacts that have at least one bounced message. When false, contacts with bounced messages will be excluded from the response. Example: true
clickboolean- When true, will retrieve statistics only for contacts that have at least one message with a registered click. When false, contacts with clicked messages will be excluded from the response. Example: true
deferredboolean- When true, will retrieve statistics only for contacts that have at least one deferred message. When false, contacts with deferred messages will be excluded from the response. Example: true
hardbouncedboolean- When true, will retrieve statistics only for contacts that have at least one hard-bounced message. When false, contacts with hard-bounced messages will be excluded from the response. Example: true
last_activity_atstring- Retrieves statistics only for contacts, for which LastActivityAt (their last received email, open, click etc.) equals the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Example: 2026-11-01T00:00:00
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
max_last_activity_atstring- Retrieves statistics only for contacts, for which LastActivityAt (their last received email, open, click etc.) is before the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Example: 2026-11-01T00:00:00
min_last_activity_atstring- Retrieves statistics only for contacts, for which LastActivityAt (their last received email, open, click etc.) is after the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Example: 2026-11-01T00:00:00
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
openboolean- When true, will retrieve statistics only for contacts that have messages with registered opens. When false, contacts with opened messages will be excluded from the response. Example: true
queuedboolean- When true, will retrieve statistics only for contacts that have queued messages. When false, contacts with queued messages will be excluded from the response. Example: true
recalculateboolean- When true, will reload all data from the database. Note: Deprecated for accounts created after April 5th, 2018. Example: true
sentboolean- When true, will retrieve statistics only for contacts that have sent messages. When false, contacts with sent messages will be excluded from the response. Example: true
softbouncedboolean- When true, will retrieve statistics only for contacts that have soft-bounced messages. When false, contacts with soft-bounced messages will be excluded from the response. Example: true
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
spamboolean- When true, will retrieve statistics for only contacts that have messages marked as Spam. When false, contacts with Spam messages will be excluded from the response. Example: true
unsubscribedboolean- When true, will retrieve statistics only for contacts that have unsubscribed from a list at least once. When false, contacts with unsubscribe events will be excluded from the response. Example: true
mailjet_contacts_listList contacts in the account, optionally only those in a contact list or targeted by a campaign.Read-onlyList Contacts
List contacts in the account, optionally only those in a contact list or targeted by a campaign. Returns Data, an array of contacts with ID, Email, Name, CreatedAt, IsExcludedFromCampaigns and DeliveredCount, plus Count and Total. Use this to browse contacts. Use mailjet_contact_get when you know the ID or email.
Inputs
campaigninteger- Retrieves only contacts targeted by this Campaign ID. Example: 123
contacts_listinteger- Retrieves only contacts that are part of this Contact List ID. Example: 123
is_excluded_from_campaignsboolean- When true, will retrieve only contacts that have been added to the exclusion list for marketing emails. When false, those contacts will be excluded from the response. Example: true
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
mailjet_dns_listList sending domains with their SPF and DKIM DNS records and status.Read-onlyList Sending Domains (DNS)
List sending domains with their SPF and DKIM DNS records and status. Returns Data, an array with ID, Domain, SPFStatus, SPFRecordValue, DKIMStatus, DKIMRecordName, DKIMRecordValue and IsCheckInProgress.
Inputs
is_check_in_progressboolean- When true, will retrieve only DNS records, where a validation check was initiated and is in progress. When false, DNS records where a check is in progress will be excluded from the response. Example: true
is_sender_identifiedboolean- Retrieves DNS records where IsSenderIdentified matches the specified value. Example: true
is_yahoo_fblboolean- Retrieves only DNS records where a Yahoo Feedback loop has been setup. Contact the Mailjet Support team to set up the feedback loop. Example: true
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
max_last_check_atstring- Retrieves only DNS records where the last check was performed before this timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Example: 2026-11-01T00:00:00
min_last_check_atstring- Retrieves only DNS records where the last check was performed after this timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Example: 2026-11-01T00:00:00
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
spf_statusstring- Retrieves only DNS records where the last domain SPF configuration check resulted in the specified status. Possible values:; OK; Error; Not checked; Not found. Example: OK
mailjet_link_click_statistics_listList click counts per link for a campaign.Read-onlyList Link Click Statistics
List click counts per link for a campaign. Returns Data, an array with URL, PositionIndex, ClickedMessagesCount and ClickedCount.
Inputs
campaign_idintegerrequired- Retrieves statistics only for the specified campaign ID. Example: 6000
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
mailjet_message_getRetrieve one sent message by its ID.Read-onlyGet Message
Retrieve one sent message by its ID. Returns Data with one message: ID, ArrivedAt, Status, ContactID, CampaignID, MessageSize, SpamassassinScore and more.
Inputs
message_idintegerrequired- Message ID, as returned by mailjet_email_send (MessageID) or mailjet_messages_list. Example: 288230380000000000
mailjet_message_history_getRetrieve the event history of one message (sent, opened, clicked, bounced, spam, unsub, blocked).Read-onlyGet Message Event History
Retrieve the event history of one message (sent, opened, clicked, bounced, spam, unsub, blocked). Returns Data, an array of events with EventAt, EventType, State, Useragent and Comment.
Inputs
message_idintegerrequired- Message ID. Example: 288230380000000000
mailjet_message_information_listList sent messages with delivery details (sender, subject, size, spam score, statistics links).Read-onlyList Message Information
List sent messages with delivery details (sender, subject, size, spam score, statistics links). Returns Data, an array with ID, CampaignID, ContactID, SendEndAt, SenderID, SpamAssassinScore, MessageSize and more, plus Count and Total.
Inputs
campaign_idinteger- Retrieves information only about messages that are part of this campaign. Example: 123
contacts_listinteger- Retrieves information only about messages that were sent to this contact list. Example: 123
custom_campaignstring- Retrieves information only about messages that are part of a campaign with the specified Custom ID. Example: november-newsletter
fromstring- Retrieves information only about messages sent from the specified sender email address. Example: orders@example.com
from_domainstring- Retrieves information only about messages sent from the specified sender domain. Example: example.com
from_idinteger- Retrieves information only about messages sent from the specified sender ID. Example: 123
from_tsstring- Retrieves information only about messages sent after the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Example: 2026-11-01T00:00:00Z
from_typeinteger- Retrieves information only for a specific type of messages:; 1 - Transactional; 2 - Marketing; 3 - Unknown. Example: 1
is_deletedboolean- When true, will retrieve information only for messages that are part of deleted campaigns. When false, messages from deleted campaigns will be excluded from the response. Example: true
is_newsletter_toolboolean- When true, will retrieve information only for campaigns created with the Legacy template builder. When false, campaigns created with the Legacy builder will be excluded from the response. Example: true
is_starredboolean- When true, will retrieve information only for messages that are part of starred campaigns. When false, messages from starred campaigns will be excluded from the response. Example: true
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
message_statusinteger- Retrieves information only for messages with the specified status:; 0 (Processed); 1 (Queued); 2 (Sent); 3 (Opened); 4 (Clicked); 5 (Bounce); 6 (Spam); 7 (Unsub); 8 (Blocked); 9 (SoftBounce); 10 (HardBounce); 11 (Deferred) Example: 0
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
periodstring- Retrieves information only for messages sent between the start of the selected period and the current timestamp.; Day - since the start of the current day; Week - since the start of the current week; Month - since the start of the current month; Year - since the start of the current year. Example: 2026-11-01T00:00:00
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
to_tsstring- Retrieves information only for messages sent before the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Example: 2026-11-01T00:00:00Z
mailjet_messages_listList sent messages with their status, filtered by campaign, contact, sender, status or time range.Read-onlyList Messages
List sent messages with their status, filtered by campaign, contact, sender, status or time range. Returns Data, an array of messages with ID, ArrivedAt, Status, ContactID, CampaignID, Subject (when ShowSubject is set) and more, plus Count and Total. Use this to find messages. Use mailjet_message_get or mailjet_message_history_get for one message.
Inputs
campaigninteger- Retrieves only messages sent as part of the specified Campaign ID. Example: 123
contactinteger- Retrieves only messages sent to the specified Contact ID. Example: 123
custom_idstring- Retrieves only messages tagged with the specified CustomID. Example: 123
destinationinteger- Retrieves only messages sent to the specified Destination ID (ID for a specific domain name). Example: 123
from_tsstring- Retrieves only messages sent after the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Example: 2026-11-01T00:00:00Z
from_typeinteger- Retrieves only messages of the specified type:; 1 - Transactional; 2 - Marketing; 3 - Unknown. Example: 1
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
message_stateinteger- Retrieves only non-delivered messages with the respective State ID. The MessageState ID explains why a message was not delivered successfully to the recipient:; 1 = user unknown (recipient); 2 = mailbox inactive (recipient); 3 = quota exceeded (recipient); 4 = invalid domain (domain); 5 = no mail host (domain); 6 = relay/access denied (domain); 7 = sender blocked (spam); 8 = content blocked (spam); 9 = policy issue (... Example: 123
message_statusinteger- Retrieves only messages with the specified status:; 0 (Processed); 1 (Queued); 2 (Sent); 3 (Opened); 4 (Clicked); 5 (Bounce); 6 (Spam); 7 (Unsub); 8 (Blocked); 9 (SoftBounce); 10 (HardBounce); 11 (Deferred) Example: 0
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
plan_subscriptioninteger- Retrieves only messages with the specified PlanSubscription ID. Example: 123
sender_idinteger- Retrieves only messages sent using a sender address with the specified ID. Example: 123
show_contact_altboolean- When true, the recipient's email address will be displayed in the message object under ContactAlt. Default value: false. Example: true
show_custom_idboolean- When true, the CustomID attached to the message will be displayed in the message object under CustomID. Default value: false. Example: true
show_subjectboolean- When true, the subject of the message will be displayed under Subject. Default value: false. Example: true
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ArrivedAt DESC
to_tsstring- Retrieves only messages sent before the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Example: 2026-11-01T00:00:00Z
mailjet_parse_routes_listList inbound Parse API routes, which forward email received at a Mailjet address to your webhook.Read-onlyList Inbound Parse Routes
List inbound Parse API routes, which forward email received at a Mailjet address to your webhook. Returns Data, an array with ID, Email, Url and APIKeyID.
Inputs
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
mailjet_recipient_esp_statistics_listList statistics for a campaign broken down by recipient email provider (Gmail, Outlook, Yahoo and others).Read-onlyList Recipient ESP Statistics
List statistics for a campaign broken down by recipient email provider (Gmail, Outlook, Yahoo and others). Returns Data, an array with ESPName and counts such as delivered, opened, clicked and bounced.
Inputs
campaign_idintegerrequired- Retrieves statistics only for the specified campaign ID. Example: 6000
esp_nameinteger- Retrieves statistics for the given ESPs only. Multiple ESPs can be separated with commas. Example: 123
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
mailjet_segments_listList segments (contact filters) that target contacts by property expressions.Read-onlyList Segments
List segments (contact filters) that target contacts by property expressions. Returns Data, an array with ID, Name, Description, Expression and Status.
Inputs
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
show_deletedboolean- When true, will retrieve all segments, including deleted ones. When false, will exclude deleted segments from the response. Default value: false. Example: true
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
statusstring- Retrieves only segments with the specified status. The status indicates whether a segment is being used for sending or not, or if it was deleted. Possible values:; used; unused; deleted. Example: used
mailjet_senders_listList sender addresses and domains registered on the account with their validation status.Read-onlyList Senders
List sender addresses and domains registered on the account with their validation status. Returns Data, an array with ID, Email, Name, Status (Active, Inactive, Deleted), EmailType, IsDefaultSender and DNSID.
Inputs
dns_idinteger- Retrieves only senders linked to this DNS ID. Example: 123
domainstring- Retrieves only senders with the specified domain in their Email. Example: example.com
emailstring- Retrieves only senders with the specified Email address. Example: jane@example.com
is_domain_senderboolean- When true, will retrieve only domain sender objects. When false, domain senders are excluded from the response. Example: true
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
local_partstring- Retrieves only senders with the specified local part in their Email address. Since the local part of domains is an asterisk, you can use this query parameter with * as its value to return only sender domains. Example: news
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
show_deletedboolean- When true, will retrieve deleted sender objects along with non-deleted ones. When false, deleted senders will be excluded from the response. Default value: false. Example: true
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
statusstring- Retrieves only senders with the specified status. Possible values:; Inactive; Active; Deleted. Example: Inactive
mailjet_stat_counters_getGet message counts (processed, delivered, opened, clicked, bounced, spam, unsubscribed and more) for the API key, a campaign or a contact list, over time or as a total.Read-onlyGet Statistics Counters
Get message counts (processed, delivered, opened, clicked, bounced, spam, unsubscribed and more) for the API key, a campaign or a contact list, over time or as a total. Returns Data, an array of counter objects with MessageSentCount, MessageDeliveredCount, MessageOpenedCount, MessageClickedCount, MessageHardBouncedCount and more, one per time slice. Use this for aggregate statistics. Use mailjet_campaign_overview_list for per-campaign summaries.
Inputs
counter_resolutionstringrequired- Defines the timescale of aggregation for your statistics. Possible values:; Highest (5-minute intervals); Hour; Day; Lifetime : cannot be used with CounterTiming=Event. Example: Lifetime
counter_sourcestringrequired- Defines the scope of aggregation for your statistics. Possible values:; Campaign; APIKey; List : Contact list. Can only be used with CounterTiming=Message&CounterResolution=Lifetime.; Sender : Sender email address. Can only be used with CounterTiming=Message. Example: Campaign
counter_timingstringrequired- Defines the reference timestamp for aggregation of statistics. More information Possible values:; Message; Event Note: If you select CounterTiming=Event, you will not be able to choose CounterResolution=Lifetime, as retrieving statistics with event-based timings needs a specific timescale to illustrate the evolution of the stats. Example: Message
from_tsstring- Retrieve statistics for messages sent after the specified timestamp. Mandatory when CounterResolution is different from Lifetime. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Note: The maximum time period that can be selected between FromTSand ToTS equals 100 times the timescale selected for CounterResolution. Example: 2026-11-01T00:00:00Z
source_idinteger- List of either Campaign IDs or ContactsList IDs (separated by commas). Mandatory when CounterSource indicates Campaign, List or Sender. Example: 0
to_tsstring- Retrieve statistics for messages sent before the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted. Note: The maximum time period that can be selected between FromTSand ToTS equals 100 times the timescale selected for CounterResolution. Example: 2026-11-01T00:00:00Z
mailjet_template_content_getRetrieve a template's content: HTML part, text part, MJML and headers (Subject, From, Reply-To).Read-onlyGet Template Content
Retrieve a template's content: HTML part, text part, MJML and headers (Subject, From, Reply-To). Returns Data with Html-part, Text-part, MJMLContent and Headers.
Inputs
template_idintegerrequired- Template ID. Example: 1234567
mailjet_template_getRetrieve one template's settings.Read-onlyGet Template
Retrieve one template's settings. Returns Data with ID, Name, Description, Purposes, EditMode, Locale, Categories and Author.
Inputs
template_idintegerrequired- Template ID. Example: 1234567
mailjet_templates_listList email templates owned by the account (and optionally Mailjet's shared templates).Read-onlyList Templates
List email templates owned by the account (and optionally Mailjet's shared templates). Returns Data, an array with ID, Name, Description, Purposes, EditMode, OwnerType, Locale and CreatedAt. Use mailjet_template_content_get for a template's HTML and text.
Inputs
categoriesstring- Retrieves information only about templates, which have the respective categories assigned. You can separate multiple categories with a comma. When selecting multiple categories, use the CategoriesSelectionMethod to specify the relation between between the selected ones and the template's list of categories. Example: newsletter
categories_selection_methodstring- Describes the relation between the value of the Categories query parameter and the template's list of categories. Possible values:; containsany; containsall; issubset Default value: containsany. Example: containsany
edit_modeinteger- Retrieves information only about templates with the specified mode of editing:; 1 - Passport drag-and-drop builder; 2 - Passport HTML builder; 3 - Passport Saved Section (snippet) builder; 4 - Passport MJML builder. Example: 1
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
namestring- Retrieves information only about templates with the specified name. Example: Newsletter
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
owner_typestring- Retrieves information only about templates with the specified owner type. Possible values:; apikey - Templates and their content can be retrieved, edited and used only by the API Key they were created from.; user - Templates created by the Primary API Key. Templates and their content can be retrieved by the Primary API Key, as well as all subaccount API Keys. Example: apikey
purposesstring- Retrieves information only about templates, which have the respective purposes assigned. You can separate multiple purposes with a comma. When selecting multiple purposes, use the PurposesSelectionMethod to specify the relation between between the selected ones and the template's list of purposes. Possible values:; marketing; transactional; automation. Example: marketing
purposes_selection_methodstring- Describes the relation between the value of the Purposes query parameter and the template's list of purposes. Possible values:; containsany; containsall; issubset. Example: containsany
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
mailjet_webhook_getRetrieve one event webhook by ID.Read-onlyGet Event Webhook
Retrieve one event webhook by ID. Returns Data with ID, EventType, Url, Status, IsBackup and Version.
Inputs
url_idintegerrequired- Event webhook ID, or the event type (for example open) Example: 123
mailjet_webhooks_listList the event webhook URLs (event callback URLs) configured on the API key.Read-onlyList Event Webhooks
List the event webhook URLs (event callback URLs) configured on the API key. Returns Data, an array with ID, EventType, Url, Status, IsBackup and Version.
Inputs
backupboolean- When true, will retrieve only backup callback URLs. When false, backup callback URLs will be excluded from the response. Example: true
event_typeinteger- Retrieves only callback URL objects linked to the specified event type:; 1 - click; 2 - bounce; 3 - spam; 4 - blocked; 5 - unsubscribe; 6 - open; 7 - sent. Example: 1
limitinteger- Number of results per page. Defaults to 10, maximum 1000. Example: 100
offsetinteger- Index of the first result to return, for paging (for example 100 with limit 100 returns results 101-200) Example: 0
sortstring- Sort by a property, optionally followed by a space and DESC (ascending by default). Not every property is sortable. Example: ID DESC
statusstring- Retrieves only callback URL objects with the specified status. Example: alive
versioninteger- Retrieves only callback URL objects with the specified Version. Possible values:; 1 - The events are not grouped and a callback is received for each event individually.; 2 - The events are grouped. A callback for the grouped events is received with a maximum frequency of once per second. Important to use to avoid reaching API rate limits. Example: 1
mailjet_campaign_draft_content_setSet a campaign draft's HTML part, text part, MJML and headers.WriteSet Campaign Draft Content
Set a campaign draft's HTML part, text part, MJML and headers. Returns Data with the saved content.
Inputs
draft_idintegerrequired- Campaign draft ID. Example: 54321
headersobject- Headers for the campaign, such as Subject and Reply-To. Example: {"Subject": "November news"}
html_partstring- The HTML-formatted part of the message. Example: <h3>Dear passenger, welcome to Mailjet!</h3><br />May the delivery force be with you!
mjml_contentstring- The content of the message in MJML. Note: Any update of the MJMLContent property of the /campaigndraft/{draft_ID}/detailcontent resource will not automatically generate the Html-part version of the content. In this case, you should regenerate the Html-part with the MJML tools. Example: <mjml><mj-body><mj-text>Hello</mj-text></mj-body></mjml>
text_partstring- The plain text part of the message. Example: Dear passenger, welcome to Mailjet! May the delivery force be with you!
mailjet_campaign_draft_createCreate a marketing campaign draft addressed to a contact list (optionally a segment).WriteCreate Campaign Draft
Create a marketing campaign draft addressed to a contact list (optionally a segment). Returns Data with the draft's ID. Next set its content with mailjet_campaign_draft_content_set, then test, schedule or send it.
Inputs
localestringrequired- Locale, in which the information is saved. Example: en_US
subjectstringrequired- Subject line for the campaign emails. Example: Your email flight plan!
contacts_list_altstring- A unique contact list email address generated by Mailjet, which is linked to this campaign draft. Required for successful sending of the campaign. Interchangeable with ContactsListID. Example: abcdef123
contacts_list_idinteger- Unique numeric ID for the contact list linked to this draft. Required for successful sending of the campaign. Interchangeable with ContactsListAlt. Example: 123456
edit_modestring- Edit mode for the campaign draft. Possible values:; tool2 - Passport drag-and-drop template editor; html2 - HTML editor in Passport; mjml - MJML editor in Passport. Example: tool2
is_starredboolean- Indicates whether the campaign draft is marked as Starred or not. Example: false
is_text_part_includedboolean- Indicates whether the draft email contains a text version or not. Example: true
reply_emailstring- Reply-to email address for the campaign. Returned only if a reply-to email was specified. Example: replyto@mailjet.com
segmentation_altstring- The user-selected name of the segment configuration (contactfilter) used for this campaign draft. Interchangeable with SegmentationID. Example: Customers under 35
segmentation_idinteger- ID of the segment configuration (contactfilter) used for this campaign draft. Interchangeable with SegmentationAlt. Example: 123
senderstring- ID of the sender email address. Required for successful sending of the campaign. Example: 1234
sender_emailstring- The email address of the sender. Required for successful sending of the campaign. Example: pilot@mailjet.com
sender_namestring- Name of the sender, which will be visible to recipients. Example: Your Mailjet Pilot
template_idinteger- Unique numeric ID of the template the CampaignDraft was generated from, or as which it was last saved. Changing the template ID will not update the content of the CampaignDraft. Example: 123456
titlestring- Internal title for this campaign draft. Example: My Mailjet Campaign
mailjet_campaign_draft_scheduleSchedule a campaign draft to be sent to its contact list at a given time.WriteSchedule Campaign Draft
Schedule a campaign draft to be sent to its contact list at a given time. Returns Data with Date and Status. Cancel with mailjet_campaign_draft_schedule_delete.
Inputs
datestringrequired- Send time in ISO 8601 (RFC 3339) format. Example: 2026-11-20T09:00:00Z
draft_idintegerrequired- Campaign draft ID. Example: 54321
mailjet_campaign_draft_sendSend a campaign draft to its contact list immediately.WriteSend Campaign Draft Now
Send a campaign draft to its contact list immediately. Returns Data with Status. Track it with mailjet_campaign_draft_status_get.
Inputs
draft_idintegerrequired- Campaign draft ID. Example: 54321
mailjet_campaign_draft_testSend a test copy of a campaign draft to up to a few addresses.WriteSend Campaign Draft Test
Send a test copy of a campaign draft to up to a few addresses. Returns Data with the test Status.
Inputs
draft_idintegerrequired- Campaign draft ID. Example: 54321
recipientsarrayrequired- Test recipients, each an object with Email and optional Name. Example: [{"Email": "qa@example.com", "Name": "QA"}]
mailjet_campaign_draft_updateChange a campaign draft's title, subject, list, segment, sender or locale.WriteUpdate Campaign Draft
Change a campaign draft's title, subject, list, segment, sender or locale. Returns Data with the updated draft.
- Idempotent
Inputs
draft_idintegerrequired- Campaign draft ID. Example: 54321
contacts_list_idinteger- Unique numeric ID for the contact list linked to this draft. Required for successful sending of the campaign. Example: 123456
edit_modestring- Edit mode for the campaign draft. Possible values:; tool2 - Passport drag-and-drop template editor; html2 - HTML editor in Passport; mjml - MJML editor in Passport. Example: tool2
is_starredboolean- Indicates whether the campaign draft is marked as Starred or not. Example: false
is_text_part_includedboolean- Indicates whether the draft email contains a text version or not. Example: true
localestring- Locale, in which the information is saved. Example: en_US
reply_emailstring- Reply-to email address for the campaign. Returned only if a reply-to email was specified. Example: replyto@mailjet.com
segmentation_altstring- The user-selected name of the segment configuration (contactfilter) used for this campaign draft. Interchangeable with SegmentationID. Example: Customers under 35
segmentation_idinteger- ID of the segment configuration (contactfilter) used for this campaign draft. Interchangeable with SegmentationAlt. Example: 123
senderstring- ID of the sender email address. Required for successful sending of the campaign. Example: 1234
sender_emailstring- The email address of the sender. Required for successful sending of the campaign. Example: pilot@mailjet.com
sender_namestring- Name of the sender, which will be visible to recipients. Example: Your Mailjet Pilot
statusstring- The status of this campaign draft. You can only modify its value only if the status is Draft (0, can be changed to -1 or -2) or Archived (-1, can be changed to -2 or 0). Example: -1
subjectstring- Subject line for the campaign emails. Example: Your email flight plan!
template_idinteger- Unique numeric ID of the template the CampaignDraft was generated from, or as which it was last saved. Changing the template ID will not update the content of the CampaignDraft. Example: 123456
titlestring- Internal title for this campaign draft. Example: My Mailjet Campaign
mailjet_contact_createCreate a contact in the account's global contact list.WriteCreate Contact
Create a contact in the account's global contact list. Returns Data with the new contact's ID, Email and Name. To add it to a list, use mailjet_contact_list_manage_contact or mailjet_contact_lists_manage.
Inputs
emailstringrequired- Contact email address. Must be unique (not present already in the global contact list). Example: passenger@mailjet.com
is_excluded_from_campaignsboolean- Indicates whether the contact is added to the exclusion list for campaigns or not. An excluded contact will not be receiving any marketing emails. Example: false
namestring- User-selected name for this contact. Example: New Contact
mailjet_contact_data_updateSet custom property values on a contact.WriteUpdate Contact Properties
Set custom property values on a contact. Properties must exist first (see mailjet_contact_properties_list). Returns Data with ContactID and the updated Data array.
- Idempotent
Inputs
contact_idstringrequired- Contact ID or email address. Example: jane@example.com
dataarray- Property values to set, each an object with Name (an existing contact property) and Value. Example: [{"Name": "first_name", "Value": "Jane"}]
mailjet_contact_list_bulk_manageStart an asynchronous job that adds, subscribes, unsubscribes or removes many contacts in one contact list.WriteBulk Manage Contacts in List
Start an asynchronous job that adds, subscribes, unsubscribes or removes many contacts in one contact list. Returns Data with the JobID; check progress with mailjet_contact_list_bulk_job_get.
Inputs
actionstringrequired- Action to be performed on the contacts for this list:; addforce - Add the contacts to this list and subscribe all of them. If the contact is already present in the list as unsubscribed, it will be forcibly subscribed once again.; addnoforce - Add the contacts to this list and subscribe them to it. If the contact is already present, it will retain its subscription status, i.e. Example: addnoforce
contactsarrayrequired- Contacts to process, each an object with Email and optional Name, IsExcludedFromCampaigns and Properties. Example: [{"Email": "jane@example.com", "Name": "Jane"}]
list_idintegerrequired- Contact list ID. Example: 12345
mailjet_contact_list_createCreate a contact list.WriteCreate Contact List
Create a contact list. Returns Data with the new list's ID, Name and Address.
Inputs
namestringrequired- User-specified name for this contact list (must be unique). Example: my_contactslist
is_deletedboolean- When true, the contact list will be marked as Deleted. Deleted lists can later be reinstated by updating this value to False. Example: false
mailjet_contact_list_manage_contactAdd, subscribe, unsubscribe or remove one contact in a contact list, creating the contact if needed.WriteAdd or Remove Contact in List
Add, subscribe, unsubscribe or remove one contact in a contact list, creating the contact if needed. Returns Data with ContactID, Email, Action, Name and Properties. Use mailjet_contact_list_bulk_manage for many contacts.
Inputs
actionstringrequired- Action to be performed on the contact for this list:; addforce - Add the contact to this list and subscribe all of them. If the contact is already present in the list as unsubscribed, it will be forcibly subscribed once again.; addnoforce - Add the contact to this list and subscribe them to it. If the contact is already present, it will retain its subscription status, i.e. Example: addnoforce
emailstringrequired- The email address of this contact. Example: passenger@mailjet.com
list_idintegerrequired- Contact list ID. Example: 12345
namestring- User-defined name for the contact. Example: John Smith
propertiesobject- A JSON object containing contact properties and their values. Each property is listed with its name as the parameter name, and the property value as the parameter value. The properties must have been created beforehand. Example: {"Name": "John Smith", "Age": 30}
mailjet_contact_list_updateRename a contact list or change its deleted flag.WriteUpdate Contact List
Rename a contact list or change its deleted flag. Returns Data with the updated list.
- Idempotent
Inputs
list_idintegerrequired- Contact list ID. Example: 12345
is_deletedboolean- When true, the contact list will be marked as Deleted. Deleted lists can later be reinstated by updating this value to False. Example: false
namestring- User-specified name for this contact list (must be unique). Example: my_contactslist
mailjet_contact_lists_manageAdd, subscribe, unsubscribe or remove one existing contact across several contact lists in one call.WriteManage Contact's Lists
Add, subscribe, unsubscribe or remove one existing contact across several contact lists in one call. Returns Data with the ContactsLists actions applied.
Inputs
contact_idstringrequired- Contact ID or email address. Example: jane@example.com
contacts_listsarrayrequired- List actions, each an object with ListID and Action (addforce, addnoforce, remove or unsub) Example: [{"ListID": 12345, "Action": "addnoforce"}]
mailjet_contact_property_createDefine a new custom contact property that contacts can hold values for.WriteCreate Contact Property
Define a new custom contact property that contacts can hold values for. Returns Data with the property's ID, Name, Datatype and NameSpace.
Inputs
namestringrequired- Name of the contact property. The name must be unique for the respective namespace. Example: first_name
datatypestring- Indicates the type of data accepted for this contact property:; str - string; int - integer; float - float / number; bool - boolean; datetime - datetime (Unix Timestamp or RFC 3339) Default value: str. Example: str
name_spacestring- Indicates the namespace of this contact property:; static - Can keep only 1 value. Each change to the value of the property for a contact overwrites the previously selected value. The values are saved in a contactdata object.; historic - Each change to the value of the property creates a record in a new contacthistorydata object, saving the property value and a timestamp of when it was submitted. Example: static
mailjet_contact_updateChange a contact's name or campaign exclusion flag.WriteUpdate Contact
Change a contact's name or campaign exclusion flag. Returns Data with the updated contact.
- Idempotent
Inputs
contact_idstringrequired- Contact ID or email address. Example: jane@example.com
is_excluded_from_campaignsboolean- Indicates whether the contact is added to the exclusion list for campaigns or not. An excluded contact will not be receiving any marketing emails. Example: false
namestring- User-selected name for this contact. Example: New Contact
mailjet_dns_checkRe-check a sending domain's SPF and DKIM records now.WriteCheck Domain DNS
Re-check a sending domain's SPF and DKIM records now. Returns Data with DKIMStatus, SPFStatus, DKIMErrors, SPFErrors and the records found.
Inputs
dns_idstringrequired- DNS (domain) ID from mailjet_dns_list, or the domain name. Example: example.com
mailjet_email_sendSend one email (from the simple inputs) or a batch of up to 50 messages (messages) with the Mailjet Send API v3.1.WriteSend Email
Send one email (from the simple inputs) or a batch of up to 50 messages (messages) with the Mailjet Send API v3.1. Returns Messages, one result per message with Status and, per recipient, Email, MessageID, MessageUUID and MessageHref (or Errors). Use this to send transactional email. Use mailjet_campaign_draft_send for a marketing campaign to a contact list. Prerequisite: the sender address must be a validated sender or domain (see mailjet_senders_list).
Inputs
advance_error_handlingboolean- Enable stricter payload checks. Example: false
attachmentsarray- Attachments, each with ContentType, Filename and Base64Content (the file as base64). Total message size is limited to 15 MB. Example: [{"ContentType": "application/pdf", "Filename": "invoice.pdf", "Base64Content": "JVBERi0xLjQK"}]
bccarray- BCC recipients, each with Email and optional Name. Example: [{"Email": "audit@example.com"}]
ccarray- CC recipients, each with Email and optional Name. Example: [{"Email": "boss@example.com"}]
custom_campaignstring- Campaign name to group these messages in statistics. Example: order-notifications
custom_idstring- Your own ID for the message (up to 64 characters), returned in events. Example: order-A1001
deduplicate_campaignboolean- Do not send the same custom_campaign to a contact twice. Example: false
event_payloadstring- Payload returned in event webhooks for this message. Example: {"order":"A1001"}
from_emailstring- Sender email address. Must be validated in Mailjet. Required unless messages is set. Example: orders@example.com
from_namestring- Sender display name. Example: Acme Orders
globalsobject- Properties applied to every message in the call (any message property except To) Example: {"CustomCampaign": "november-receipts"}
headersobject- Extra email headers, as an object of header name to value. Example: {"X-Order-ID": "A1001"}
html_partstring- HTML body. Provide text_part, html_part or template_id. Example: <h3>Hi Jane</h3><p>Your order is on its way.</p>
inlined_attachmentsarray- Inline images, each with ContentType, Filename, ContentID and Base64Content; reference them in HTML as cid:ContentID. Example: [{"ContentType": "image/png", "Filename": "logo.png", "ContentID": "logo", "Base64Content": "iVBORw0KGgo="}]
messagesarray- Full Send API v3.1 message objects for a batch (up to 50), each with From, To and content fields such as Subject, TextPart, HTMLPart or TemplateID. When set, the single-message inputs above are ignored. Example: [{"From": {"Email": "orders@example.com"}, "To": [{"Email": "jane@example.com"}], "Subject": "Hi", "TextPart": "Hello"}]
priorityinteger- Processing priority in your account's queue, 0 (lowest) to 3 (highest) Example: 2
reply_to_emailstring- Reply-To address. Example: help@example.com
sandbox_modeboolean- Validate the request without delivering anything. Example: false
subjectstring- Subject line. Example: Your order has shipped
template_idinteger- ID of a Mailjet template to use as the content (see mailjet_templates_list) Example: 1234567
template_languageboolean- Process the Mailjet template language in the content (needed for variables) Example: true
text_partstring- Plain-text body. Provide text_part, html_part or template_id. Example: Hi Jane, your order is on its way.
toarray- Recipients, each an object with Email and an optional Name. Required unless messages is set. Example: [{"Email": "jane@example.com", "Name": "Jane Doe"}]
track_clicksstring- Click tracking for this message. Example: enabledone of
account_defaultdisabledenabled track_opensstring- Open tracking for this message. Example: enabledone of
account_defaultdisabledenabled url_tagsstring- Query string appended to every link, without the leading ? Example: utm_source=mailjet&utm_medium=email
variablesobject- Template language variables for this message, as an object of name to value. Example: {"first_name": "Jane", "order_id": "A1001"}
mailjet_parse_route_createCreate an inbound route: email sent to the route's address is parsed and POSTed as JSON to your URL.WriteCreate Inbound Parse Route
Create an inbound route: email sent to the route's address is parsed and POSTed as JSON to your URL. Returns Data with the route's ID, Email (the receiving address, generated when not given) and Url.
Inputs
urlstringrequired- The webhook URL, where you want to receive the parsed email information. Note: The URL provided cannot be a root URL. Example: https://www.example.com/123/
api_key_idinteger- Unique numeric API Key ID to whom this object belongs. Example: 123456
emailstring- The email address you want to use. Emails sent to this address will be parsed and the information passed on to the webhook URL in JSON format. If not selected, an email address will automatically be generated by Mailjet. Example: parseroute@example.com
mailjet_segment_createCreate a segment (contact filter) from an expression over contact properties, for use as a campaign's SegmentationID.WriteCreate Segment
Create a segment (contact filter) from an expression over contact properties, for use as a campaign's SegmentationID. Returns Data with the segment's ID, Name and Expression.
Inputs
expressionstringrequired- The rule, based on which the segment is calculated. Refer to our Segmentation Guide for detailed information on the syntax. Example: (age<35)
namestringrequired- User-selected name for this segment. Example: Customers under 35
descriptionstring- A description of the segment you can add for convenience, or to easier understand its functionality. Example: Will send only to contacts under 35 years of age.
mailjet_sender_createRegister a sender address (or *@domain) so you can send from it.WriteCreate Sender
Register a sender address (or *@domain) so you can send from it. Mailjet emails a validation link. Returns Data with the sender's ID and Status. Then validate with mailjet_sender_validate.
Inputs
emailstringrequired- The email address or domain for this sender. Example: pilot@mailjet.com
email_typestring- Type of emails this sender will send. This is for purely informative purposes - the values do not place any sending restrictions on the sender email or domain.; transactional - transactional emails; bulk - campaign emails; unknown - both. Example: bulk
is_default_senderboolean- Indicates whether this is the default sender or not. Example: false
namestring- User-provided name for this sender. Example: Marketing sender
mailjet_sender_validateCheck whether a sender's domain DNS or validation email is complete and activate it.WriteValidate Sender
Check whether a sender's domain DNS or validation email is complete and activate it. Returns Data with ValidationMethod and Errors, or Status when already validated.
Inputs
sender_idintegerrequired- Sender ID. Example: 56789
mailjet_template_content_setSet a template's content: HTML part, text part, MJML and headers.WriteSet Template Content
Set a template's content: HTML part, text part, MJML and headers. Replaces the existing content. Returns Data with the saved content.
Inputs
template_idintegerrequired- Template ID. Example: 1234567
headersobject- Default headers for the template, such as Subject, From ("Name <email>") and Reply-To. Example: {"Subject": "Your order {{var:order_id}}", "From": "Acme <orders@example.com>"}
html_partstring- The HTML-formatted content of the template with Mustache-like logic. Example: <h3>Dear passenger, welcome to Mailjet!</h3><br />May the delivery force be with you!
mjml_contentstring- The content of the template in MJML. Example: <mjml><mj-body><mj-text>Hello</mj-text></mj-body></mjml>
text_partstring- The plain text content of the template with Mustache-like logic. Example: Dear passenger, welcome to Mailjet! May the delivery force be with you!
mailjet_template_createCreate a template record.WriteCreate Template
Create a template record. Add its HTML and text with mailjet_template_content_set. Returns Data with the template's ID and settings.
Inputs
namestringrequired- Internal name for this template. Example: Promo Codes
authorstring- The name of the template author. Example: John Doe
categoriesstring- An array containing a list of strings indicating the categories, to which the template is associated. Accepted values are full, basic, newsletter, e-commerce, events, travel, sports, welcome, contact-property-update, support, invoice, anniversary, account, activation. Example: array
copyrightstring- The Copyright message. Example: Mailjet
descriptionstring- Free text used as a description for this template. Example: Used to send out promo codes.
edit_modeinteger- Edit mode for this template:; 1 - Passport drag-and-drop builder; 2 - Passport HTML builder; 3 - Passport Saved Section (snippet) builder; 4 - Passport MJML builder When a template is created through the API, the value has to be set by the caller - there is no fallback. Templates created in the Mailjet app are always 1 - Passport drag-and-drop builder. Example: 1
is_starredboolean- Indicates whether this campaign is marked as starred or not. Default value: false. Example: false
is_text_part_generation_enabledboolean- Indicates whether the generation of a text version of the template will be enabled or not. Default value: false. Example: true
localestring- The locale for this template (AnsiString). Default value: en_US. Example: en_US
owner_typestring- Indicates the type of the template owner. Possible values:; apikey - Templates and their content can be retrieved, edited and used only by the API Key they were created from.; user - Templates created by the Primary API Key. Templates and their content can be retrieved by the Primary API Key, as well as all subaccount API Keys. Example: user
presetsstring- A JSON string containing the different pre-defined styles for this template. Example: string
purposesarray- An array indicating whether the template is a marketing, transactional or automation one. Upon POST request only the first value in the array is taken into account. Possible values:; marketing; transactional; automation If no value is set, the template will not be visible in the Mailjet app, as there is no tab under which to display it. Example: ["transactional"]
mailjet_template_updateChange a template's name, description, purposes, locale or categories.WriteUpdate Template
Change a template's name, description, purposes, locale or categories. Returns Data with the updated template.
- Idempotent
Inputs
template_idintegerrequired- Template ID. Example: 1234567
authorstring- The name of the template author. Example: John Doe
categoriesstring- An array containing a list of strings indicating the categories, to which the template is associated. Accepted values are full, basic, newsletter, e-commerce, events, travel, sports, welcome, contact-property-update, support, invoice, anniversary, account, activation. Example: array
copyrightstring- The Copyright message. Example: Mailjet
descriptionstring- Free text used as a description for this template. Example: Used to send out promo codes.
edit_modeinteger- Edit mode for this template:; 1 - Passport drag-and-drop builder; 2 - Passport HTML builder; 3 - Passport Saved Section (snippet) builder; 4 - Passport MJML builder When a template is created through the API, the value has to be set by the caller - there is no fallback. Templates created in the Mailjet app are always 1 - Passport drag-and-drop builder. Example: 1
is_starredboolean- Indicates whether this campaign is marked as starred or not. Default value: false. Example: false
is_text_part_generation_enabledboolean- Indicates whether the generation of a text version of the template will be enabled or not. Default value: false. Example: true
localestring- The locale for this template (AnsiString). Default value: en_US. Example: en_US
namestring- Internal name for this template. Example: Promo Codes
owner_typestring- Indicates the type of the template owner. Possible values:; apikey - Templates and their content can be retrieved, edited and used only by the API Key they were created from.; user - Templates created by the Primary API Key. Templates and their content can be retrieved by the Primary API Key, as well as all subaccount API Keys. Example: user
presetsstring- A JSON string containing the different pre-defined styles for this template. Example: string
purposesarray- An array indicating whether the template is a marketing, transactional or automation one. Upon POST request only the first value in the array is taken into account. Possible values:; marketing; transactional; automation If no value is set, the template will not be visible in the Mailjet app, as there is no tab under which to display it. Example: ["transactional"]
mailjet_webhook_createRegister a URL that Mailjet POSTs events of one type to (sent, open, click, bounce, spam, blocked, unsub).WriteCreate Event Webhook
Register a URL that Mailjet POSTs events of one type to (sent, open, click, bounce, spam, blocked, unsub). Returns Data with the new webhook's ID, EventType, Url and Status.
Inputs
urlstringrequired- The URL used for this object. Note: The URL provided cannot be a root URL. Example: https://www.example.com/123/
event_typestring- The type of event that is being tracked. Possible values:; open; click; bounce; spam; blocked; unsub; sent Default value: open. Example: open
is_backupboolean- Indicates whether this is a backup URL or not. The backup URL will be used in case the primary one is suspended. Example: false
statusstring- Defines whether the callback URL is active or not. Possible values:; dead; alive. Example: alive
mailjet_webhook_updateChange an event webhook's URL, event type, status or backup flag.WriteUpdate Event Webhook
Change an event webhook's URL, event type, status or backup flag. Returns Data with the updated webhook.
- Idempotent
Inputs
url_idintegerrequired- Event webhook ID. Example: 123
event_typestring- The type of event that is being tracked. Possible values:; open; click; bounce; spam; blocked; unsub; sent Default value: open. Example: open
is_backupboolean- Indicates whether this is a backup URL or not. The backup URL will be used in case the primary one is suspended. Example: false
statusstring- Defines whether the callback URL is active or not. Possible values:; dead; alive. Example: alive
urlstring- The URL used for this object. Note: The URL provided cannot be a root URL. Example: https://www.example.com/123/
mailjet_campaign_draft_schedule_deleteCancel a campaign draft's scheduled send; the draft stays.DestructiveCancel Campaign Schedule
Cancel a campaign draft's scheduled send; the draft stays. Returns no content (204).
- Idempotent
Inputs
draft_idintegerrequired- Campaign draft ID. Example: 54321
mailjet_contact_list_deleteDelete a contact list.DestructiveDelete Contact List
Delete a contact list. The contacts themselves stay in the account. Returns no content (204).
- Idempotent
Inputs
list_idintegerrequired- Contact list ID. Example: 12345
mailjet_parse_route_deleteDelete an inbound parse route.DestructiveDelete Inbound Parse Route
Delete an inbound parse route. Returns no content (204).
- Idempotent
Inputs
parseroute_idintegerrequired- Parse route ID. Example: 123
mailjet_sender_deleteDelete a sender address.DestructiveDelete Sender
Delete a sender address. Returns no content (204).
- Idempotent
Inputs
sender_idintegerrequired- Sender ID. Example: 56789
mailjet_template_deleteDelete a template.DestructiveDelete Template
Delete a template. Returns no content (204).
- Idempotent
Inputs
template_idintegerrequired- Template ID. Example: 1234567
mailjet_webhook_deleteDelete an event webhook.DestructiveDelete Event Webhook
Delete an event webhook. Returns no content (204).
- Idempotent
Inputs
url_idintegerrequired- Event webhook ID. Example: 123
No tools match.