To send your first newsletter, you need to have at least one active sender address in the Sender domains & addresses section.
You will need to create contacts and organize them into lists. To do so, you have two options : use the interface or the API.
<?php
/*
Create : only need a Name
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'Name' => "myList"
];
$response = $mj->post(Resources::$Contactslist, ['body' => $body]);
$response->success() && var_dump($response->getData());
?># Create : only need a Name
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/contactslist \
-H 'Content-Type: application/json' \
-d '{
"Name":"myList"
}'/**
*
* Create : only need a Name
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("contactslist")
.request({
"Name":"myList"
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Create : only need a Name
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Contactslist.create(name: "myList"
)
p variable.attributes['Data']"""
Create : only need a Name
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
data = {
'Name': 'myList'
}
result = mailjet.contactslist.create(data=data)
print result.status_code
print result.json()/*
Create : only need a Name
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.Contactslist
mr := &Request{
Resource: "contactslist",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.Contactslist {
Name: "myList",
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.resource.Contactslist;
public class MyClass {
/**
* Create : only need a Name
*/
public static void main(String[] args) throws MailjetException {
ClientOptions clientOptions;
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
clientOptions = ClientOptions
.builder()
.apiKey(System.getenv("MJ_APIKEY_PUBLIC"))
.apiSecretKey(System.getenv("MJ_APIKEY_PRIVATE"))
.build();
client = new MailjetClient(clientOptions);
request = new MailjetRequest(Contactslist.resource)
.property(Contactslist.NAME, "myList");
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Create : only need a Name
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = Contactslist.Resource,
}
.Property(Contactslist.Name, "myList");
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}API response:
{
"Count": 1,
"Data": [
{
"Address": "",
"CreatedAt": "",
"ID": "",
"IsDeleted": "false",
"Name": "myList",
"SubscriberCount": ""
}
],
"Total": 1
}You can create your contacts list by performing a simple POST request on the /contactslist resource with only one mandatory field : its name.
The Name will be a unique identifier for your list.
<?php
/*
Create : Manage the details of a Contact.
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'Email' => "[email protected]"
];
$response = $mj->post(Resources::$Contact, ['body' => $body]);
$response->success() && var_dump($response->getData());
?># Create : Manage the details of a Contact.
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/contact \
-H 'Content-Type: application/json' \
-d '{
"Email":"[email protected]"
}'/**
*
* Create : Manage the details of a Contact.
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("contact")
.request({
"Email":"[email protected]"
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Create : Manage the details of a Contact.
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Contact.create(email: "[email protected]"
)
p variable.attributes['Data']"""
Create : Manage the details of a Contact.
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
data = {
'Email': '[email protected]'
}
result = mailjet.contact.create(data=data)
print result.status_code
print result.json()/*
Create : Manage the details of a Contact.
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.Contact
mr := &Request{
Resource: "contact",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.Contact {
Email: "[email protected]",
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.Contact;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Create : Manage the details of a Contact.
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(Contact.resource)
.property(Contact.EMAIL, "[email protected]");
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Create : Manage the details of a Contact.
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = Contact.Resource,
}
.Property(Contact.Email, "[email protected]");
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}API response:
{
"Count": 1,
"Data": [
{
"CreatedAt": "",
"DeliveredCount": "",
"Email": "[email protected]",
"ExclusionFromCampaignsUpdatedAt": "",
"ID": "",
"IsExcludedFromCampaigns": "false",
"IsOptInPending": "false",
"IsSpamComplaining": "false",
"LastActivityAt": "",
"LastUpdateAt": "",
"Name": "MisterMailjet",
"UnsubscribedAt": "",
"UnsubscribedBy": ""
}
],
"Total": 1
}To create some contacts which will be the recipients, you need to specify an email address with POST on the /contact resource.
The email address will be a unique identifier of your contact in the Mailjet System.
The /contact resource allows you to create contacts using their email addresses and names. If you want to add more granular details about your contacts, Mailjet provides the capability to add custom data to contacts.
The addition of custom data starts with the definition of the extra information to store with the contacts (It could be for example the country the contacts live in, how old the contacts are, their current income, the value of their purchases on your site...) and how this data will be stored (string, number, boolean...).
<?php
/*
Create : Definition of available extra data items for contacts.
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'Datatype' => "str",
'Name' => "Age",
'NameSpace' => "static"
];
$response = $mj->post(Resources::$Contactmetadata, ['body' => $body]);
$response->success() && var_dump($response->getData());
?># Create : Definition of available extra data items for contacts.
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/contactmetadata \
-H 'Content-Type: application/json' \
-d '{
"Datatype":"str",
"Name":"Age",
"NameSpace":"static"
}'/**
*
* Create : Definition of available extra data items for contacts.
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("contactmetadata")
.request({
"Datatype":"str",
"Name":"Age",
"NameSpace":"static"
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Create : Definition of available extra data items for contacts.
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Contactmetadata.create(datatype: "str",
name: "Age",
name_space: "static"
)
p variable.attributes['Data']/*
Create : Definition of available extra data items for contacts.
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.Contactmetadata
mr := &Request{
Resource: "contactmetadata",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.Contactmetadata {
Datatype: "str",
Name: "Age",
NameSpace: "static",
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.Contactmetadata;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Create : Definition of available extra data items for contacts.
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(Contactmetadata.resource)
.property(Contactmetadata.DATATYPE, "str")
.property(Contactmetadata.NAME, "Age")
.property(Contactmetadata.NAMESPACE, "static");
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Create : Definition of available extra data items for contacts.
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = Contactmetadata.Resource,
}
.Property(Contactmetadata.Datatype, "str")
.Property(Contactmetadata.Name, "Age")
.Property(Contactmetadata.NameSpace, "static");
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}"""
Create : Definition of available extra data items for contacts.
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
data = {
'Datatype': 'str',
'Name': 'Age',
'NameSpace': 'static'
}
result = mailjet.contactmetadata.create(data=data)
print result.status_code
print result.json()API response:
{
"Count": 1,
"Data": [
{
"Datatype": "str",
"ID": "",
"Name": "Age",
"NameSpace": "static"
}
],
"Total": 1
}To define custom contact data, perform a POST on /contactmetadata with the following properties:
Name: the name of the custom data fieldDataType: the type of data that is being stored (this can be either astr,int,float,datetimeorbool)NameSpace: this can be eitherstaticorhistoric(legacy)
For example, to store the age of each contacts, a static int "Age" property can be added to the metadata.
A static data stores only one value per DataType. It could store for example a first name, a last name, country, language, etc.
A historic (legacy) data stores a timestamped history of the value of this data.
The static namespace has its own resources for viewing, creating and editing: /contactdata
The contact data will be available for personalization of your message content and for segmentation of your lists.
<?php
/*
Modify : Modify the static custom contact data
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'Data' => [
[
'Name' => "Age",
'value' => 30
],
[
'Name' => "Country",
'value' => "US"
]
]
];
$response = $mj->put(Resources::$Contactdata, ['id' => $id, 'body' => $body]);
$response->success() && var_dump($response->getData());
?># Modify : Modify the static custom contact data
curl -s \
-X PUT \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/contactdata/$CONTACT_ID \
-H 'Content-Type: application/json' \
-d '{
"Data":[
{
"Name": "Age",
"value": 30
},
{
"Name": "Country",
"value": "US"
}
]
}'/**
*
* Modify : Modify the static custom contact data
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.put("contactdata")
.id($CONTACT_ID)
.request({
"Data":[
{
"Name": "Age",
"value": 30
},
{
"Name": "Country",
"value": "US"
}
]
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Modify : Modify the static custom contact data
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
target = Mailjet::Contactdata.find($CONTACT_ID)
target.update_attributes(data: [{
'Name'=> 'Age',
'value'=> 30
}, {
'Name'=> 'Country',
'value'=> 'US'
}]
)
p variable.attributes['Data']"""
Modify : Modify the static custom contact data
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
id = '$CONTACT_ID'
data = {
'Data': [
{
"Name": "Age",
"value": 30
},
{
"Name": "Country",
"value": "US"
}
]
}
result = mailjet.contactdata.update(id=id, data=data)
print result.status_code
print result.json()/*
Modify : Modify the static custom contact data
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
mr := &Request{
Resource: "contactdata",
ID: RESOURCE_ID,
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.Contactdata {
Data: []MailjetDat {
MailjetDat {
Name: "Age",
Value: 30,
},
MailjetDat {
Name: "Country",
Value: "US",
},
},
},
}
err := mailjetClient.Put(fmr)
if err != nil {
fmt.Println(err)
}
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.Contactdata;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Modify : Modify the static custom contact data
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(Contactdata.resource, ID)
.property(Contactdata.DATA, new JSONArray()
.put(new JSONObject()
.put("Name", "Age")
.put("value", "30"))
.put(new JSONObject()
.put("Name", "Country")
.put("value", "US")));
response = client.put(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Modify : Modify the static custom contact data
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = Contactdata.Resource,
ResourceId = ResourceId.Numeric(ID)
}
.Property(Contactdata.Data, new JArray {
new JObject {
{"Name", "Age"},
{"value", 30}
},
new JObject {
{"Name", "Country"},
{"value", "US"}
}
});
MailjetResponse response = await client.PutAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}By Performing a PUT (acting like a PATCH, your other static datas will not be lost) on /contactdata, you can add values for several metadata at once.
<?php
/*
Create : Manage the details of a Contact.
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'Contacts' => [
[
'Email' => "[email protected]",
'Name' => "Jim",
'Properties' => [
'Property1' => "value",
'Property2' => "value2"
]
],
[
'Email' => "[email protected]",
'Name' => "Janet",
'Properties' => [
'Property1' => "value",
'Property2' => "value2"
]
]
]
];
$response = $mj->post(Resources::$ContactManagemanycontacts, ['body' => $body]);
$response->success() && var_dump($response->getData());
?># Create : Manage the details of a Contact.
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/contact/managemanycontacts \
-H 'Content-Type: application/json' \
-d '{
"Contacts":[
{
"Email": "[email protected]",
"Name": "Jim",
"Properties": {
"Property1": "value",
"Property2": "value2"
}
},
{
"Email": "[email protected]",
"Name": "Janet",
"Properties": {
"Property1": "value",
"Property2": "value2"
}
}
]
}'/**
*
* Create : Manage the details of a Contact.
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("contact")
.action("managemanycontacts")
.request({
"Contacts":[
{
"Email": "[email protected]",
"Name": "Jim",
"Properties": {
"Property1": "value",
"Property2": "value2"
}
},
{
"Email": "[email protected]",
"Name": "Janet",
"Properties": {
"Property1": "value",
"Property2": "value2"
}
}
]
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Create : Manage the details of a Contact.
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Contact_managemanycontacts.create(contacts: [{
'Email'=> '[email protected]',
'Name'=> 'Jim',
'Properties'=> {
'Property1'=> 'value',
'Property2'=> 'value2'
}
}, {
'Email'=> '[email protected]',
'Name'=> 'Janet',
'Properties'=> {
'Property1'=> 'value',
'Property2'=> 'value2'
}
}]
)
p variable.attributes['Data']"""
Create : Manage the details of a Contact.
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
data = {
'Contacts': [
{
"Email": "[email protected]",
"Name": "Jim",
"Properties": {
"Property1": "value",
"Property2": "value2"
}
},
{
"Email": "[email protected]",
"Name": "Janet",
"Properties": {
"Property1": "value",
"Property2": "value2"
}
}
]
}
result = mailjet.contact_managemanycontacts.create(data=data)
print result.status_code
print result.json()/*
Create : Manage the details of a Contact.
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.ContactManagemanycontacts
mr := &Request{
Resource: "contact",
Action: "managemanycontacts",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.ContactManagemanycontacts {
Contacts: []MailjetContact {
MailjetContact {
Email: "[email protected]",
Name: "Jim",
Properties: MyPropertiesStruct {
Property1: "value",
Property2: "value2",
},
},
MailjetContact {
Email: "[email protected]",
Name: "Janet",
Properties: MyPropertiesStruct {
Property1: "value",
Property2: "value2",
},
},
},
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.ContactManagemanycontacts;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Create : Manage the details of a Contact.
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(ContactManagemanycontacts.resource)
.property(ContactManagemanycontacts.CONTACTS, new JSONArray()
.put(new JSONObject()
.put("Email", "[email protected]")
.put("Name", "Jim")
.put("Properties", new JSONObject()
.put("Property1", "value")
.put("Property2", "value2")))
.put(new JSONObject()
.put("Email", "[email protected]")
.put("Name", "Janet")
.put("Properties", new JSONObject()
.put("Property1", "value")
.put("Property2", "value2"))));
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Create : Manage the details of a Contact.
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = ContactManagemanycontacts.Resource,
}
.Property(ContactManagemanycontacts.Contacts, new JArray {
new JObject {
{"Email", "[email protected]"},
{"Name", "Jim"},
{"Properties", new JObject {
{"Property1", "value"},
{"Property2", "value2"}
}}
},
new JObject {
{"Email", "[email protected]"},
{"Name", "Janet"},
{"Properties", new JObject {
{"Property1", "value"},
{"Property2", "value2"}
}}
}
});
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}Mailjet offers the /contact/managemanycontacts resource to create or update multiple contacts and their properties at once.
<?php
/*
Create : Manage a contact subscription to a list
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'ContactsLists' => [
[
'ListID' => "$ListID_1",
'Action' => "addnoforce"
],
[
'ListID' => "$ListID_2",
'Action' => "addforce"
]
]
];
$response = $mj->post(Resources::$ContactManagecontactslists, ['id' => $id, 'body' => $body]);
$response->success() && var_dump($response->getData());
?># Create : Manage a contact subscription to a list
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/contact/$ID/managecontactslists \
-H 'Content-Type: application/json' \
-d '{
"ContactsLists":[
{
"ListID": "$ListID_1",
"Action": "addnoforce"
},
{
"ListID": "$ListID_2",
"Action": "addforce"
}
]
}'/**
*
* Create : Manage a contact subscription to a list
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("contact")
.id($ID)
.action("managecontactslists")
.request({
"ContactsLists":[
{
"ListID": "$ListID_1",
"Action": "addnoforce"
},
{
"ListID": "$ListID_2",
"Action": "addforce"
}
]
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Create : Manage a contact subscription to a list
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Contact_managecontactslists.create(id: $ID, contacts_lists: [{
'ListID'=> '$ListID_1',
'Action'=> 'addnoforce'
}, {
'ListID'=> '$ListID_2',
'Action'=> 'addforce'
}]
)
p variable.attributes['Data']"""
Create : Manage a contact subscription to a list
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
id = '$ID'
data = {
'ContactsLists': [
{
"ListID": "$ListID_1",
"Action": "addnoforce"
},
{
"ListID": "$ListID_2",
"Action": "addforce"
}
]
}
result = mailjet.contact_managecontactslists.create(id=id, data=data)
print result.status_code
print result.json()/*
Create : Manage a contact subscription to a list
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.ContactManagecontactslists
mr := &Request{
Resource: "contact",
ID: RESOURCE_ID,
Action: "managecontactslists",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.ContactManagecontactslists {
ContactsLists: []MailjetContactsList {
MailjetContactsList {
ListID: "$ListID_1",
Action: "addnoforce",
},
MailjetContactsList {
ListID: "$ListID_2",
Action: "addforce",
},
},
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.ContactManagecontactslists;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Create : Manage a contact subscription to a list
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(ContactManagecontactslists.resource, ID)
.property(ContactManagecontactslists.CONTACTSLISTS, new JSONArray()
.put(new JSONObject()
.put("ListID", "$ListID_1")
.put("Action", "addnoforce"))
.put(new JSONObject()
.put("ListID", "$ListID_2")
.put("Action", "addforce")));
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Create : Manage a contact subscription to a list
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = ContactManagecontactslists.Resource,
ResourceId = ResourceId.Numeric(ID)
}
.Property(ContactManagecontactslists.ContactsLists, new JArray {
new JObject {
{"ListID", "$ListID_1"},
{"Action", "addnoforce"}
},
new JObject {
{"ListID", "$ListID_2"},
{"Action", "addforce"}
}
});
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}Last step: you have to add this contact to a previously created contact list.
POST on the /contact/$ID/managecontactslists with $ID being the Mailjet contact ID or the email address of the contact.
You can specify one or more lists to add this contact to. The Action specified with the ListID can be addforce (force the subscription of the contact even if he unsubscribed to the list before) or addnoforce (do not resubscribe the contact to the list if unsubscribed before)
managecontactslist offer more possibilities of list management for a contact. More information
<?php
/*
Add a contact to the list
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'Email' => "[email protected]",
'Name' => "MrSmith",
'Action' => "addnoforce",
'Properties' => [
'property1' => "value",
'propertyN' => "valueN"
]
];
$response = $mj->post(Resources::$ContactslistManagecontact, ['id' => $id, 'body' => $body]);
$response->success() && var_dump($response->getData());
?># Add a contact to the list
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/contactslist/$LIST_ID/managecontact \
-H 'Content-Type: application/json' \
-d '{
"Email":"[email protected]",
"Name":"MrSmith",
"Action":"addnoforce",
"Properties":{
"property1": "value",
"propertyN": "valueN"
}
}'/**
*
* Add a contact to the list
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("contactslist")
.id($LIST_ID)
.action("managecontact")
.request({
"Email":"[email protected]",
"Name":"MrSmith",
"Action":"addnoforce",
"Properties":{
"property1": "value",
"propertyN": "valueN"
}
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Add a contact to the list
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Contactslist_managecontact.create(id: $LIST_ID, , , , email: "[email protected]",
name: "MrSmith",
action: "addnoforce",
properties: {
'property1'=> 'value',
'propertyN'=> 'valueN'
}
)
p variable.attributes['Data']"""
Add a contact to the list
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
id = '$LIST_ID'
data = {
'Email': '[email protected]',
'Name': 'MrSmith',
'Action': 'addnoforce',
'Properties': {
"property1": "value",
"propertyN": "valueN"
}
}
result = mailjet.contactslist_managecontact.create(id=id, data=data)
print result.status_code
print result.json()/*
Add a contact to the list
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
type MyPropertiesStruct struct {
Property1 string
PropertyN string
}
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.ContactslistManagecontact
mr := &Request{
Resource: "contactslist",
ID: RESOURCE_ID,
Action: "managecontact",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.ContactslistManagecontact {
Email: "[email protected]",
Name: "MrSmith",
Action: "addnoforce",
Properties: MyPropertiesStruct {
Property1: "value",
PropertyN: "valueN",
},
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.ContactslistManagecontact;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Add a contact to the list
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(ContactslistManagecontact.resource, ID)
.property(ContactslistManagecontact.EMAIL, "[email protected]")
.property(ContactslistManagecontact.NAME, "MrSmith")
.property(ContactslistManagecontact.ACTION, "addnoforce")
.property(ContactslistManagecontact.PROPERTIES, new JSONObject()
.put("property1", "value")
.put("propertyN", "valueN"));
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Add a contact to the list
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = ContactslistManagecontact.Resource,
ResourceId = ResourceId.Numeric(ID)
}
.Property(ContactslistManagecontact.Email, "[email protected]")
.Property(ContactslistManagecontact.Name, "MrSmith")
.Property(ContactslistManagecontact.Action, "addnoforce")
.Property(ContactslistManagecontact.Properties, new JObject {
{"property1", "value"},
{"propertyN", "valueN"}
});
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}API response:
{
"Count": 1,
"Data": [
{
"ContactID": "10",
"Email": "[email protected]",
"Action": "addnoforce",
"Name": "MrSmith",
"Properties": {
"property1": "value",
"propertyN": "valueN"
}
}
],
"Total": 1
}The /contactslist/$ID/managecontact allows you to create and add a contact to a list in one call.
The properties specified in this call can only be static Contact data. The Contact
'Action' is mandatory and can be one of the following values:
| Actions | |
|---|---|
| addforce | string adds the contact and resets the unsub status to false |
| addnoforce | string adds the contact and does not change the subscription status of the contact |
| remove | string removes the contact from the list |
| unsub | string unsubscribes a contact from the list |
The response will include the ID of the contact that was created or updated.
/contactmetadata
Error response:
{
"ErrorInfo": {
"Properties": [
{
"property1": "Property not defined"
},
{
"propertyN": "Property type does not match definition"
}
]
},
"ErrorMessage": "Object properties invalid",
"StatusCode": 400
}In case of error, /contactslist/$ID/managecontact will return JSON payload containing an ErrorInfo and ErrorMessage.
This resource allows you to add contacts in bulk in a JSON format. Optionally, these contacts can be added to existing lists. More information
This resource allows you to add contacts directly to a list. It will create new contacts if they are not already in the Mailjet system. More information
This process allows you to upload CSV files containing large quantities of contacts. More information
# Create : CampaignDraft data
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/campaigndraft \
-H 'Content-Type: application/json' \
-d '{
"Locale":"en_US",
"Sender":"MisterMailjet",
"SenderEmail":"[email protected]",
"Subject":"Greetings from Mailjet",
"ContactsListID":"$ID_CONTACTSLIST",
"Title":"Friday newsletter"
}'<?php
/*
Create : CampaignDraft data
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'Locale' => "en_US",
'Sender' => "MisterMailjet",
'SenderEmail' => "[email protected]",
'Subject' => "Greetings from Mailjet",
'ContactsListID' => "$ID_CONTACTSLIST",
'Title' => "Friday newsletter"
];
$response = $mj->post(Resources::$Campaigndraft, ['body' => $body]);
$response->success() && var_dump($response->getData());
?>/**
*
* Create : CampaignDraft data
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("campaigndraft")
.request({
"Locale":"en_US",
"Sender":"MisterMailjet",
"SenderEmail":"[email protected]",
"Subject":"Greetings from Mailjet",
"ContactsListID":"$ID_CONTACTSLIST",
"Title":"Friday newsletter"
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Create : CampaignDraft data
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Campaigndraft.create(locale: "en_US",
sender: "MisterMailjet",
sender_email: "[email protected]",
subject: "Greetings from Mailjet",
contacts_list_id: "$ID_CONTACTSLIST",
title: "Friday newsletter"
)
p variable.attributes['Data']"""
Create : CampaignDraft data
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
data = {
'Locale': 'en_US',
'Sender': 'MisterMailjet',
'SenderEmail': '[email protected]',
'Subject': 'Greetings from Mailjet',
'ContactsListID': '$ID_CONTACTSLIST',
'Title': 'Friday newsletter'
}
result = mailjet.campaigndraft.create(data=data)
print result.status_code
print result.json()/*
Create : CampaignDraft data
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.Campaigndraft
mr := &Request{
Resource: "campaigndraft",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.Campaigndraft {
Locale: "en_US",
Sender: "MisterMailjet",
SenderEmail: "[email protected]",
Subject: "Greetings from Mailjet",
ContactsListID: "$ID_CONTACTSLIST",
Title: "Friday newsletter",
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.Campaigndraft;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Create : CampaignDraft data
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(Campaigndraft.resource)
.property(Campaigndraft.LOCALE, "en_US")
.property(Campaigndraft.SENDER, "MisterMailjet")
.property(Campaigndraft.SENDEREMAIL, "[email protected]")
.property(Campaigndraft.SUBJECT, "Greetings from Mailjet")
.property(Campaigndraft.CONTACTSLISTID, "$ID_CONTACTSLIST")
.property(Campaigndraft.TITLE, "Friday newsletter");
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Create : CampaignDraft data
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = Campaigndraft.Resource,
}
.Property(Campaigndraft.Locale, "en_US")
.Property(Campaigndraft.Sender, "MisterMailjet")
.Property(Campaigndraft.SenderEmail, "[email protected]")
.Property(Campaigndraft.Subject, "Greetings from Mailjet")
.Property(Campaigndraft.ContactsListID, "$ID_CONTACTSLIST")
.Property(Campaigndraft.Title, "Friday newsletter");
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}API response:
{
"Count": 1,
"Data": [
{
"AXFractionName": "",
"AXTesting": "",
"CampaignID": "",
"ContactsListID": "$ID_CONTACTSLIST",
"CreatedAt": "",
"Current": "",
"DeliveredAt": "",
"EditMode": "",
"ID": "",
"IsStarred": "false",
"IsTextPartIncluded": "false",
"Locale": "en_US",
"ModifiedAt": "",
"Preset": "",
"ReplyEmail": "",
"SegmentationID": "",
"Sender": "MisterMailjet",
"SenderEmail": "[email protected]",
"SenderName": "",
"Status": "",
"Subject": "Greetings from Mailjet",
"Template": "",
"Title": "Friday newsletter",
"Url": "",
"Used": "false"
}
],
"Total": 1
}To create a campaign draft, perform a POST on the /campaigndraft resource. Required fields are a Locale, Sender, SenderEmail, Subject and ContactsListID.
# Modify : CampaignDraft content data.
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/campaigndraft/$ID/detailcontent \
-H 'Content-Type: application/json' \
-d '{
"Html-part":"Hello <strong>world</strong>!",
"Text-part":"Hello world!"
}'<?php
/*
Modify : CampaignDraft content data.
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'Html-part' => "Hello <strong>world</strong>!",
'Text-part' => "Hello world!"
];
$response = $mj->post(Resources::$CampaigndraftDetailcontent, ['id' => $id, 'body' => $body]);
$response->success() && var_dump($response->getData());
?>/**
*
* Modify : CampaignDraft content data.
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("campaigndraft")
.id($ID)
.action("detailcontent")
.request({
"Html-part":"Hello <strong>world</strong>!",
"Text-part":"Hello world!"
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Modify : CampaignDraft content data.
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Campaigndraft_detailcontent.create(id: $ID, , html_part: "Hello <strong>world</strong>!",
text_part: "Hello world!"
)
p variable.attributes['Data']"""
Modify : CampaignDraft content data.
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
id = '$ID'
data = {
'Html-part': 'Hello <strong>world</strong>!',
'Text-part': 'Hello world!'
}
result = mailjet.campaigndraft_detailcontent.create(id=id, data=data)
print result.status_code
print result.json()/*
Modify : CampaignDraft content data.
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.CampaigndraftDetailcontent
mr := &Request{
Resource: "campaigndraft",
ID: RESOURCE_ID,
Action: "detailcontent",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.CampaigndraftDetailcontent {
HtmlPart: "Hello <strong>world</strong>!",
TextPart: "Hello world!",
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.CampaigndraftDetailcontent;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Modify : CampaignDraft content data.
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(CampaigndraftDetailcontent.resource, ID)
.property(CampaigndraftDetailcontent.HTMLPART, "Hello <strong>world</strong>!")
.property(CampaigndraftDetailcontent.TEXTPART, "Hello world!");
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Modify : CampaignDraft content data.
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = CampaigndraftDetailcontent.Resource,
ResourceId = ResourceId.Numeric(ID)
}
.Property(CampaigndraftDetailcontent.Htmlpart, "Hello <strong>world</strong>!")
.Property(CampaigndraftDetailcontent.Textpart, "Hello world!");
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}API response :
{
"Count": 1,
"Data": [
{
"Html-part": "Hello <strong>world</strong>!",
"Text-part": "Hello world!"
}
],
"Total": 1
}Now that we have a campaign draft, we can add the most important property: its content, which can be Text or Html (Text-part or Html-part). To do so, you can perform a PUT or POST request on the /campaigndraft/$ID/detailcontent resource.
With a POST, if you only give a value to Html-part or Text-part, the other one will be set to empty.
While with a PUT, if you only give a value to Html-part or Text-part, the other one keeps its previous value.
MJMLContent property of the /campaigndraft/$ID/detailcontent resource will not automaticaly generate the Html-part version of the content. In this case, you should regenerate the Html-part with the MJML tools.
<?php
/*
Create : CampaignDraft test
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'Recipients' => [
[
'Email' => "[email protected]",
'Name' => "Mailjet"
]
]
];
$response = $mj->post(Resources::$CampaigndraftTest, ['id' => $id, 'body' => $body]);
$response->success() && var_dump($response->getData());
?># Create : CampaignDraft test
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/campaigndraft/$ID/test \
-H 'Content-Type: application/json' \
-d '{
"Recipients":[
{
"Email": "[email protected]",
"Name": "Mailjet"
}
]
}'/**
*
* Create : CampaignDraft test
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("campaigndraft")
.id($ID)
.action("test")
.request({
"Recipients":[
{
"Email": "[email protected]",
"Name": "Mailjet"
}
]
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Create : CampaignDraft test
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Campaigndraft_test.create(id: $ID, recipients: [{
'Email'=> '[email protected]',
'Name'=> 'Mailjet'
}]
)
p variable.attributes['Data']"""
Create : CampaignDraft test
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
id = '$ID'
data = {
'Recipients': [
{
"Email": "[email protected]",
"Name": "Mailjet"
}
]
}
result = mailjet.campaigndraft_test.create(id=id, data=data)
print result.status_code
print result.json()package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.CampaigndraftTest;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Create : CampaignDraft test
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(CampaigndraftTest.resource, ID)
.property(CampaigndraftTest.RECIPIENTS, new JSONArray()
.put(new JSONObject()
.put("Email", "[email protected]")
.put("Name", "Mailjet")));
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}/*
Create : CampaignDraft test
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.CampaigndraftTest
mr := &Request{
Resource: "campaigndraft",
ID: RESOURCE_ID,
Action: "test",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.CampaigndraftTest {
Recipients: []MailjetRecipient {
MailjetRecipient {
Email: "[email protected]",
Name: "Mailjet",
},
},
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Create : CampaignDraft test
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = CampaigndraftTest.Resource,
ResourceId = ResourceId.Numeric(ID)
}
.Property(CampaigndraftTest.Recipients, new JArray {
new JObject {
{"Email", "[email protected]"},
{"Name", "Mailjet"}
}
});
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}API response:
{
"Count": 1,
"Data": [
{
"Status": "Draft"
}
],
"Total": 1
}To send a test version of a draft, you need to perform a POST request on the resource /campaigndraft/$ID/test with a recipient in the JSON packet.
<?php
/*
Send a CampaignDraft
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$response = $mj->post(Resources::$CampaigndraftSend, ['id' => $id]);
$response->success() && var_dump($response->getData());
?># Send a CampaignDraft
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/campaigndraft/$ID/send \
-H 'Content-Type: application/json' \
-d '{
}'/**
*
* Send a CampaignDraft
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("campaigndraft")
.id($ID)
.action("send")
.request()
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Send a CampaignDraft
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Campaigndraft_send.create(id: $ID)
p variable.attributes['Data']"""
Send a CampaignDraft
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
id = '$ID'
result = mailjet.campaigndraft_send.create(id=id)
print result.status_code
print result.json()/*
Send a CampaignDraft
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.CampaigndraftSend
mr := &Request{
Resource: "campaigndraft",
ID: RESOURCE_ID,
Action: "send",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.CampaigndraftSend {
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.CampaigndraftSend;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Send a CampaignDraft
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(CampaigndraftSend.resource, ID);
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Send a CampaignDraft
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = CampaigndraftSend.Resource,
ResourceId = ResourceId.Numeric(ID)
}
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}API response:
{
"Count": 1,
"Data": [
{
"Status": "programmed"
}
],
"Total": 1
}Once the campaign draft is completely set up, it can be sent with a POST on the /campaigndraft/$ID/send resource.
Before sending, the API will check if the draft has all mandatory fields filled in and that they are valid :
SenderEmailis a valid senderSenderis not emptySubjectis not emptyContactsListis an existing contact list with more than one active subscribed recipientStatusisDraftorProgrammedText-partand/orHtml-partexistAXTestingis not set for this draft
Schedule a camp for the 22nd of April, 2015 at 9am UTC+1
<?php
/*
Create : CampaignDraft schedule
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'date' => "2015-04-22T09:00:00+01:00"
];
$response = $mj->post(Resources::$CampaigndraftSchedule, ['id' => $id, 'body' => $body]);
$response->success() && var_dump($response->getData());
?># Create : CampaignDraft schedule
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/campaigndraft/$ID/schedule \
-H 'Content-Type: application/json' \
-d '{
"date":"2015-04-22T09:00:00+01:00"
}'/**
*
* Create : CampaignDraft schedule
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("campaigndraft")
.id($ID)
.action("schedule")
.request({
"date":"2015-04-22T09:00:00+01:00"
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Create : CampaignDraft schedule
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Campaigndraft_schedule.create(id: $ID, date: "2015-04-22T09:00:00+01:00"
)
p variable.attributes['Data']"""
Create : CampaignDraft schedule
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
id = '$ID'
data = {
'date': '2015-04-22T09:00:00+01:00'
}
result = mailjet.campaigndraft_schedule.create(id=id, data=data)
print result.status_code
print result.json()/*
Create : CampaignDraft schedule
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.CampaigndraftSchedule
mr := &Request{
Resource: "campaigndraft",
ID: RESOURCE_ID,
Action: "schedule",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.CampaigndraftSchedule {
Date: "2015-04-22T09:00:00+01:00",
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.CampaigndraftSchedule;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Create : CampaignDraft schedule
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(CampaigndraftSchedule.resource, ID)
.property(CampaigndraftSchedule.DATE, "2015-04-22T09:00:00+01:00");
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Create : CampaignDraft schedule
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = CampaigndraftSchedule.Resource,
ResourceId = ResourceId.Numeric(ID)
}
.Property(CampaigndraftSchedule.date, "2015-04-22T09:00:00+01:00");
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}API response:
{
"Count": 1,
"Data": [
{
"Status": "programmed"
}
],
"Total": 1
}To send a campaign at a later date, we need to set the date property (ISO 8601 format) at which the campaign shall be sent using the /campaigndraft/$ID/schedule resource.
Before scheduling, the API will check if the campaign draft has all mandatory fields filled in and that they are valid:
SenderEmailis a valid senderSenderis not emptySubjectis not emptyContactsListis an existing contact list with more than one active subscribed recipientStatusisDraftorProgrammedText-partand/orHtml-partexistAXTestingis not set for this campaign draft- Date of scheduling is not in the past or too close to the execution
The value NOW is accepted as a date to indicate immediate sending.
In order to cancel scheduled campaign, you should use DELETE action on /campaigndraft/$ID/schedule resource.
<?php
/*
View : CampaignDraft data.
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$response = $mj->get(Resources::$Campaigndraft, ['id' => $id]);
$response->success() && var_dump($response->getData());
?># View : CampaignDraft data.
curl -s \
-X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/campaigndraft/$ID /**
*
* View : CampaignDraft data.
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.get("campaigndraft")
.id($ID)
.request()
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})"""
View : CampaignDraft data.
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
id = '$ID'
result = mailjet.campaigndraft.get(id=id)
print result.status_code
print result.json()# View : CampaignDraft data.
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Campaigndraft.find($ID)
p variable.attributes['Data']/*
View : CampaignDraft data.
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.Campaigndraft
mr := &Request{
Resource: "campaigndraft",
ID: RESOURCE_ID,
}
err := mailjetClient.Get(mr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.Campaigndraft;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* View : CampaignDraft data.
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(Campaigndraft.resource, ID);
response = client.get(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// View : CampaignDraft data.
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = Campaigndraft.Resource,
ResourceId = ResourceId.Numeric(ID)
}
MailjetResponse response = await client.GetAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}API response:
{
"Count": 1,
"Data": [
{
"AXFractionName": "",
"AXTesting": "",
"CampaignID": "",
"ContactsListID": "$ID_CONTACTSLIST",
"CreatedAt": "",
"Current": "",
"DeliveredAt": "",
"EditMode": "",
"ID": "",
"IsStarred": "false",
"IsTextPartIncluded": "false",
"Locale": "en_US",
"ModifiedAt": "",
"Preset": "",
"ReplyEmail": "",
"SegmentationID": "",
"Sender": "MisterMailjet",
"SenderEmail": "[email protected]",
"SenderName": "",
"Status": "",
"Subject": "Greetings from Mailjet",
"Template": "",
"Title": "Friday newsletter",
"Url": "",
"Used": "false"
}
],
"Total": 1
}Using a GET on the /campaigndraft resource, you can find the Status of your draft.
The status can have the following value:
-2: deleted-1: archived draft0: draft1: programmed2: sent3: A/X tesring
<?php
/*
Create : A filter expressions for use in newsletters.
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'Description' => "Only contacts aged 40",
'Expression' => "age=40",
'Name' => "40 year olds"
];
$response = $mj->post(Resources::$Contactfilter, ['body' => $body]);
$response->success() && var_dump($response->getData());
?># Create : A filter expressions for use in newsletters.
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/contactfilter \
-H 'Content-Type: application/json' \
-d '{
"Description":"Only contacts aged 40",
"Expression":"age=40",
"Name":"40 year olds"
}'/**
*
* Create : A filter expressions for use in newsletters.
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("contactfilter")
.request({
"Description":"Only contacts aged 40",
"Expression":"age=40",
"Name":"40 year olds"
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Create : A filter expressions for use in newsletters.
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Contactfilter.create(description: "Only contacts aged 40",
expression: "age=40",
name: "40 year olds"
)
p variable.attributes['Data']"""
Create : A filter expressions for use in newsletters.
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
data = {
'Description': 'Only contacts aged 40',
'Expression': 'age=40',
'Name': '40 year olds'
}
result = mailjet.contactfilter.create(data=data)
print result.status_code
print result.json()/*
Create : A filter expressions for use in newsletters.
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.Contactfilter
mr := &Request{
Resource: "contactfilter",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.Contactfilter {
Description: "Only contacts aged 40",
Expression: "age=40",
Name: "40 year olds",
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.Contactfilter;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Create : A filter expressions for use in newsletters.
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(Contactfilter.resource)
.property(Contactfilter.DESCRIPTION, "Only contacts aged 40")
.property(Contactfilter.EXPRESSION, "age=40")
.property(Contactfilter.NAME, "40 year olds");
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Create : A filter expressions for use in newsletters.
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = Contactfilter.Resource,
}
.Property(Contactfilter.Description, "Only contacts aged 40")
.Property(Contactfilter.Expression, "age=40")
.Property(Contactfilter.Name, "40 year olds");
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}API response:
{
"Count": 1,
"Data": [
{
"Description": "Only contacts contacts aged 40",
"Expression": "age=40",
"ID": "",
"Name": "40 year olds",
"Status": "unused"
}
],
"Total": 1
}Our /contactfilter resource allows you to create segmentation formulas (contact filters), and then use them to send campaigns to certain subsets of your contact lists. A filter can be applied to any contact metadata that you defined, like age, gender, and location. In addition, you can filter based on the opens and clicks (or lack thereof) by contacts for a specific period.
To specify the segment of contacts you want to target with your campaign, you need to select the set of requirements to be fulfilled by those contacts. This is done via the Expression property in a contactfilter object.
You can create simple expressions using the =, <, > and != operators. Every single expression should be presented in parentheses.
"Expression": "(string_property=\"male\")"
"Expression": "(integer_property<40)"
"Expression": "(boolean_property=true)"
You can also apply the negative statement not. When using not, the expression should be surrounded by an additional set of parentheses:
"Expression": "((not IsProvided(date)))"
You can combine simple expressions using AND and OR operators to formulate complex ones. When entering more than two expressions, you need to specify the order of operations by adding additional sets of parentheses.
"Expression": "((string_property=\"male\") AND (integer_property<32)) OR (boolean_property=true)"
"Expression": "(string_property=\"male\") AND ((integer_property<32) OR (boolean_property=true))"
| Operator | Meaning | Data types supported | Example |
|---|---|---|---|
| = | Is / Is equal to | all | (gender=\”male\”) |
| != | Does not equal | Integer, decimal, date | (age!=32) |
| < , <= | Is less than, Is less than or equal to | Integer, decimal | (age<32) |
| >, >= | Is greater than, is greater than or equal to | Integer, decimal | (age>32) |
| IsBetweenNumbers | Is between the selected numbers | Integer, decimal | (IsBetweenNumbers(orders,1,5)) |
| IsProvided | Is provided | all | (IsProvided(address)) |
| <> | Is not | string | (country<>\”France\”) |
| StartsWith | Starts with | string | (StartsWith(country,\”fr\”)) |
| EndsWith | Ends with | string | (EndsWith(promo_code,\”DEC\”)) |
| Contains | Contains | string | (Contains(address,\”London\”)) |
| ToDate | Used to specify timestamps for expressions | date | (property<ToDate(1556658000)) |
| DateTimeNow() | Used to specify the current timestamp | date | (FormatDateTime("yy-mm-dd",anniversary)=FormatDateTime("yy-mm-dd",DateTimeNow())) |
| FormatDateTime | Used to specify the format of the timestamp | date | (FormatDateTime("yy-mm-dd",birthday)=FormatDateTime("yy-mm-dd",DateTimeNow())) |
| Between | Is between the selected timestamps | date | (Between(last_purchase,"2019-05-01T09:00:00.000Z","2019-05-02T09:00:00.000Z")) |
| IsInNextDays | Is in the next X days | date | (IsInNextDays(birthday,1)) |
| IsInPreviousDays | Is in the previous X days | date | (IsInPreviousDays(last_purchase,1)) |
| FormatDateTimeTZ | Used to specify timestamp with timezone | date | (FormatDateTimeTZ("mm-dd",anniversary,"+03:00")="01-01") |
| hasopenedsince | Contact has generated an open event within the last X days | N/A | (hasopenedsince(1)) |
| hasclickedsince | Contact has generated a click event within the last X days | N/A | (hasclickedsince(1)) |
- Men between the ages of 18 and 35 living in New York
"Expression": "(IsBetweenNumbers(age,18,35)) AND (gender=\"male\") AND (city=\"New York\")"
- Users that have not generated a click event in the last month, or have not generated an open event in the last year
"Expression": "((not hasclickedsince(30))) OR ((not hasopenedsince(365)))"
- Users that have a birthday today (CET time zone)
"Expression": "(FormatDateTimeTZ(\"mm-dd\",birthday,\"+01:00\")=FormatDateTime(\"mm-dd\",DateTimeNow()))"
- Male users over the age of 40, or female users over 45
"Expression": "((gender=\"male\") AND (age>40)) OR ((gender=\"female\") AND (age>45))"
<?php
/*
Create : CampaignDraft data
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$body = [
'Locale' => "en_US",
'Sender' => "MisterMailjet",
'SenderEmail' => "[email protected]",
'Subject' => "Greetings from Mailjet",
'ContactsListID' => "$ID_CONTACTSLIST",
'Title' => "Friday newsletter",
'SegmentationID' => "$ID_CONTACT_FILTER"
];
$response = $mj->post(Resources::$Campaigndraft, ['body' => $body]);
$response->success() && var_dump($response->getData());
?># Create : CampaignDraft data
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/campaigndraft \
-H 'Content-Type: application/json' \
-d '{
"Locale":"en_US",
"Sender":"MisterMailjet",
"SenderEmail":"[email protected]",
"Subject":"Greetings from Mailjet",
"ContactsListID":"$ID_CONTACTSLIST",
"Title":"Friday newsletter",
"SegmentationID":"$ID_CONTACT_FILTER"
}'/**
*
* Create : CampaignDraft data
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.post("campaigndraft")
.request({
"Locale":"en_US",
"Sender":"MisterMailjet",
"SenderEmail":"[email protected]",
"Subject":"Greetings from Mailjet",
"ContactsListID":"$ID_CONTACTSLIST",
"Title":"Friday newsletter",
"SegmentationID":"$ID_CONTACT_FILTER"
})
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# Create : CampaignDraft data
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Campaigndraft.create(locale: "en_US",
sender: "MisterMailjet",
sender_email: "[email protected]",
subject: "Greetings from Mailjet",
contacts_list_id: "$ID_CONTACTSLIST",
title: "Friday newsletter",
segmentation_id: "$ID_CONTACT_FILTER"
)
p variable.attributes['Data']"""
Create : CampaignDraft data
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
data = {
'Locale': 'en_US',
'Sender': 'MisterMailjet',
'SenderEmail': '[email protected]',
'Subject': 'Greetings from Mailjet',
'ContactsListID': '$ID_CONTACTSLIST',
'Title': 'Friday newsletter',
'SegmentationID': '$ID_CONTACT_FILTER'
}
result = mailjet.campaigndraft.create(data=data)
print result.status_code
print result.json()/*
Create : CampaignDraft data
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.Campaigndraft
mr := &Request{
Resource: "campaigndraft",
}
fmr := &FullRequest{
Info: mr,
Payload: &resources.Campaigndraft {
Locale: "en_US",
Sender: "MisterMailjet",
SenderEmail: "[email protected]",
Subject: "Greetings from Mailjet",
ContactsListID: "$ID_CONTACTSLIST",
Title: "Friday newsletter",
SegmentationID: "$ID_CONTACT_FILTER",
},
}
err := mailjetClient.Post(fmr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.Campaigndraft;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* Create : CampaignDraft data
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(Campaigndraft.resource)
.property(Campaigndraft.LOCALE, "en_US")
.property(Campaigndraft.SENDER, "MisterMailjet")
.property(Campaigndraft.SENDEREMAIL, "[email protected]")
.property(Campaigndraft.SUBJECT, "Greetings from Mailjet")
.property(Campaigndraft.CONTACTSLISTID, "$ID_CONTACTSLIST")
.property(Campaigndraft.TITLE, "Friday newsletter")
.property(Campaigndraft.SEGMENTATIONID, "$ID_CONTACT_FILTER");
response = client.post(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// Create : CampaignDraft data
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = Campaigndraft.Resource,
}
.Property(Campaigndraft.Locale, "en_US")
.Property(Campaigndraft.Sender, "MisterMailjet")
.Property(Campaigndraft.SenderEmail, "[email protected]")
.Property(Campaigndraft.Subject, "Greetings from Mailjet")
.Property(Campaigndraft.ContactsListID, "$ID_CONTACTSLIST")
.Property(Campaigndraft.Title, "Friday newsletter")
.Property(Campaigndraft.SegmentationID, "$ID_CONTACT_FILTER");
MailjetResponse response = await client.PostAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}Segmentation is achieved by adding a contact filter to a campaign draft resource using the property SegmentationID. $ID_CONTACT_FILTER is the ID of the contact filter that was created on the previous step.
A new campaign resource is created for each campaign draft and transactional email sent. You can query the campaign resource and its related statistics resources for a variety of data like bounces, number of clicks, and sending time.
# View : Campaign linked to the Newsletter :NEWSLETTER_ID
curl -s \
-X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/campaign/mj.nl=$NEWSLETTER_ID <?php
/*
View : Campaign linked to the Newsletter :NEWSLETTER_ID
*/
require 'vendor/autoload.php';
use \Mailjet\Resources;
$mj = new \Mailjet\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'));
$response = $mj->get(Resources::$Campaign, ['id' => $id]);
$response->success() && var_dump($response->getData());
?>/**
*
* View : Campaign linked to the Newsletter :NEWSLETTER_ID
*
*/
const mailjet = require ('node-mailjet')
.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)
const request = mailjet
.get("campaign")
.id(mj.nl=$NEWSLETTER_ID)
.request()
request
.then((result) => {
console.log(result.body)
})
.catch((err) => {
console.log(err.statusCode)
})# View : Campaign linked to the Newsletter :NEWSLETTER_ID
require 'mailjet'
Mailjet.configure do |config|
config.api_key = ENV['MJ_APIKEY_PUBLIC']
config.secret_key = ENV['MJ_APIKEY_PRIVATE']
end
variable = Mailjet::Campaign.find(mj.nl=$NEWSLETTER_ID)
p variable.attributes['Data']"""
View : Campaign linked to the Newsletter :NEWSLETTER_ID
"""
from mailjet_rest import Client
import os
api_key = os.environ['MJ_APIKEY_PUBLIC']
api_secret = os.environ['MJ_APIKEY_PRIVATE']
mailjet = Client(auth=(api_key, api_secret))
id = 'mj.nl=$NEWSLETTER_ID'
result = mailjet.campaign.get(id=id)
print result.status_code
print result.json()/*
View : Campaign linked to the Newsletter :NEWSLETTER_ID
*/
package main
import (
"fmt"
"log"
"os"
mailjet "github.com/mailjet/mailjet-apiv3-go/v4"
"github.com/mailjet/mailjet-apiv3-go/v4/resources"
)
func main () {
mailjetClient := NewMailjetClient(os.Getenv("MJ_APIKEY_PUBLIC"), os.Getenv("MJ_APIKEY_PRIVATE"))
var data []resources.Campaign
mr := &Request{
Resource: "campaign",
ID: RESOURCE_ID,
}
err := mailjetClient.Get(mr, &data)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Data array: %+v\n", data)
}package com.my.project;
import com.mailjet.client.errors.MailjetException;
import com.mailjet.client.errors.MailjetSocketTimeoutException;
import com.mailjet.client.MailjetClient;
import com.mailjet.client.MailjetRequest;
import com.mailjet.client.MailjetResponse;
import com.mailjet.client.resource.Campaign;
import org.json.JSONArray;
import org.json.JSONObject;
public class MyClass {
/**
* View : Campaign linked to the Newsletter :NEWSLETTER_ID
*/
public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {
MailjetClient client;
MailjetRequest request;
MailjetResponse response;
client = new MailjetClient(System.getenv("MJ_APIKEY_PUBLIC"), System.getenv("MJ_APIKEY_PRIVATE"));
request = new MailjetRequest(Campaign.resource, ID);
response = client.get(request);
System.out.println(response.getStatus());
System.out.println(response.getData());
}
}using Mailjet.Client;
using Mailjet.Client.Resources;
using System;
using Newtonsoft.Json.Linq;
namespace Mailjet.ConsoleApplication
{
class Program
{
/// <summary>
/// View : Campaign linked to the Newsletter :NEWSLETTER_ID
/// </summary>
static void Main(string[] args)
{
RunAsync().Wait();
}
static async Task RunAsync()
{
MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable("MJ_APIKEY_PUBLIC"), Environment.GetEnvironmentVariable("MJ_APIKEY_PRIVATE"));
MailjetRequest request = new MailjetRequest
{
Resource = Campaign.Resource,
ResourceId = ResourceId.Numeric(ID)
}
MailjetResponse response = await client.GetAsync(request);
if (response.IsSuccessStatusCode)
{
Console.WriteLine(string.Format("Total: {0}, Count: {1}\n", response.GetTotal(), response.GetCount()));
Console.WriteLine(response.GetData());
}
else
{
Console.WriteLine(string.Format("StatusCode: {0}\n", response.StatusCode));
Console.WriteLine(string.Format("ErrorInfo: {0}\n", response.GetErrorInfo()));
Console.WriteLine(response.GetData());
Console.WriteLine(string.Format("ErrorMessage: {0}\n", response.GetErrorMessage()));
}
}
}
}API response:
{
"Count": 1,
"Data": [
{
"CampaignType": "",
"ClickTracked": "",
"CreatedAt": "",
"CustomValue": "",
"FirstMessageID": "",
"FromID": "",
"FromEmail": "[email protected]",
"FromName": "",
"HasHtmlCount": "",
"HasTxtCount": "",
"ID": "",
"IsDeleted": "false",
"IsStarred": "false",
"ListID": "",
"NewsLetterID": "",
"OpenTracked": "",
"SegmentationID": "",
"SendEndAt": "",
"SendStartAt": "",
"SpamassScore": "",
"Status": "",
"Subject": "",
"UnsubscribeTrackedCount": ""
}
],
"Total": 1
}When a campaign is created from the processing of a newsletter, its CustomValue property is set to mj.nl=$NEWSLETTER_ID where $NEWSLETTER_ID is the ID of the newsletter you just sent. You can use mj.nl=$NEWSLETTER_ID as a unique key to retrieve the campaign.
The main resource to be used to retrieve campaign statistics is /statcounters. See the Statistics section for details on the available resources and on how to set up your calls to view the information by campaign.
[/campaigndraft] replaced [/newsletter] for the management and configuration of campaign drafts.
/campaigndraft is used to access all drafts created with Passport and through the /campaigndraft API resource.
/newsletter can still be used to access all drafts created with Mailjet old builder and through the /newsletter API resource.
/campaigndraft will not allow access to any of the drafts created with /newsletter
If you have been using the /newsletter API resource to create campaign drafts, make sure to continue to use the /newsletter resource to access them.