Automizy REST API Docs

{
  "Content-Type": "application/json",
  "Accept": "application/json"
}
                

{
  "Authorization": "Bearer <ACCESS TOKEN>",
  "Content-Type": "application/json",
  "Accept": "application/json"
}
                

 $ curl 'https://api.automizy.com/segments/7/calculate?waitForResponse=true&saveAfterFinish=false' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/segments/7/calculate",
    data: {
        waitForResponse:true,
        saveAfterFinish:false
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
                

//Just calculate, no save
 $AA.segments().calculateById(7) //returns jqXHR

//Calculate and save
 $AA.segments().calculateAndSave(7) //returns jqXHR
                

HTTP/1.1 200 OK
{
   numberOfContacts: "10000"
}
                

 $ curl 'https://api.automizy.com/segments' \
-X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
    "name": "New Segment",
    "conditions": [
        [
           {
                "type":"EMAIL",
                "relation":"IN",
                "value":"@gmail."
           },
           {
                "type":"CUSTOM_FIELD",
                "relation":"EQ",
                "value":"payed",
                "customField":13
           }
        ],
        [
            {
                "type":"CONTACT_TAG",
                "relation":"IN",
                "value":"test_tag"
            },
            {
                "type":"LEAD_SCORE",
                "relation":"GT",
                "value":1000
            }
        ]
    ]
 }'
                

$.ajax({
    type: "POST",
    url: "https://api.automizy.com/segments",
    data:{
        name: "New Segment",
        conditions: [
            [
               {
                    type:"EMAIL",
                    relation:"IN",
                    value:"@gmail."
               },
               {
                    type:"CUSTOM_FIELD",
                    relation:"EQ",
                    value:"payed",
                    customField:13
               }
            ],
            [
                {
                    type:"CONTACT_TAG",
                    relation:"IN",
                    value:"test_tag"
                },
                {
                    type:"LEAD_SCORE",
                    relation:"GT",
                    value:1000
                }
            ]
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.segments().insert({
    name: "New Segment",
    conditions: [
        [
           {
                type:"EMAIL",
                relation:"IN",
                value:"@gmail."
           },
           {
                type:"CUSTOM_FIELD",
                relation:"EQ",
                value:"payed",
                customField:13
           }
        ],
        [
            {
                type:"CONTACT_TAG",
                relation:"IN",
                value:"test_tag"
            },
            {
                type:"LEAD_SCORE",
                relation:"GT",
                value:1000
            }
        ]
    ]
}) //returns jqXHR
                

HTTP/1.1 200 OK
{
	"id":182,
	"name":"New segment",
	"createDate":{
		"date":"2016-01-13 10:38:04",
		"timezone_type":3,
		"timezone":"Europe\/Budapest"
	},
	"subscriberCount":0,
	"conditions":[
        [
           {
                "type":"EMAIL",
                "relation":"IN",
                "value":"@gmail."
           },
           {
                "type":"CUSTOM_FIELD",
                "relation":"EQ",
                "value":"payed",
                "customField":13
           }
        ],
        [
            {
                "type":"SUBSCRIBE_DATE",
                "relation":"GT",
                "value":{
                    "date":"2016-01-13 10:37:02",
                    "timezone_type":3,
                    "timezone":"Europe\/Budapest"
                }
            },
            {
                "type":"LEAD_SCORE",
                "relation":"GT",
                "value":1000
            }
        ]
    ],
	"_links":{
		"self":{
			"href":"https:\/\/api.automizy.com\/segments\/182"
		},
		"calculate":{
			"href":"https:\/\/api.automizy.com\/segments\/182\/calculate"
		},
		"contacts":{
			"href":"https:\/\/api.automizy.com\/segments\/182\/contacts"
		}
	}
}
                

# Getting page 2 with 5 elements per page ordered by id:
$ curl 'https://api.automizy.com/segments?limit=5&page=2&order=id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'

#Getting only the id from the entity with only self link:
$ curl 'https://api.automizy.com/segments?fields=id&links=none' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'

#Getting the collection first ordered descending by name:
$ curl 'https://api.automizy.com/segments?order=name:desc' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'

#THIS CASE IS SHOWN IN THE RESPONSE
#Filtering the collection where name contains the word 'test'
$ curl 'https://api.automizy.com/segments?where%5B0%5D%5B0%5D%5B0%5D=name&where%5B0%5D%5B0%5D%5B0%5D=like&where%5B0%5D%5B0%5D%5B0%5D=%test%' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

//THIS CASE IS SHOWN IN THE RESPONSE
//Filtering the collection where name contains the word 'test'
$.ajax({
    type: "GET",
    url: "https://api.automizy.com/segments",
    data:{
        where:[
            [
                ['name', 'like', '%test%']
            ]
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

//THIS CASE IS SHOWN IN THE RESPONSE
//Filtering the collection where name contains the word 'test'
$AA.segments().where([
    [
        ["name", "like", "%test%"]
    ]
]).get() //returns jqXHR
                

HTTP/1.1 200 OK
{
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/segments?where%5B0%5D%5B0%5D%5B0%5D=name\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25test%25\u0026page=1"
        },
        "first": {
            "href": "https:\/\/api.automizy.com\/segments?where%5B0%5D%5B0%5D%5B0%5D=name\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25test%25"
        },
        "last": {
            "href": "https:\/\/api.automizy.com\/segments?where%5B0%5D%5B0%5D%5B0%5D=name\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25test%25\u0026page=1"
        }
    },
    "_embedded": {
        "segments": [{
            "id": 20,
            "name": "TestSegment",
            "createDate": {
                "date": "2015-11-12 10:47:35",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "subscriberCount": 10,
            "conditions": [
                [{
                    "type": "EMAIL",
                    "relation": "IN",
                    "value": "@gmail"
                }]
            ],
            "_links": {
                "self": {
                    "href": "https:\/\/api.automizy.com\/segments\/20"
                },
                "calculate": {
                    "href": "https:\/\/api.automizy.com\/segments\/20\/calculate"
                },
                "contacts": {
                    "href": "https:\/\/api.automizy.com\/segments\/20\/contacts"
                }
            }
        }]
    },
    "page_count": 1,
    "page_size": 9223372036854775807, //there was no limit set
    "total_items": 1,
    "page": 1
}
                

$ curl 'https://api.automizy.com/segments/7' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/segments/7",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.segments().getRecordById(7) //returns jqXHR
                

HTTP/1.1 200 OK
{
    "id": 7,
    "name": "Segment7",
    "createDate": {
        "date": "2015-11-10 11:45:45",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "subscriberCount": 6,
    "conditions": [
        [{
            "type": "IMPORT_FILE",
            "relation": "IN",
            "value": "19"
        }]
    ],
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/segments\/7"
        },
        "calculate": {
            "href": "https:\/\/api.automizy.com\/segments\/7\/calculate"
        },
        "contacts": {
            "href": "https:\/\/api.automizy.com\/segments\/7\/contacts"
        }
    }
}
                

$ curl 'https://api.automizy.com/segments/7' \
-X DELETE \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "DELETE",
    url: "https://api.automizy.com/segments/7",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.segments().delete(7) //returns jqXHR
                

 $ curl 'https://api.automizy.com/segments/7' \
-X PATCH \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
    "name": "Updated",
    "conditions": [
            [
               {
                    "type":"EMAIL",
                    "relation":"IN",
                    "value":"@gmail."
               },
               {
                    "type":"CUSTOM_FIELD",
                    "relation":"EQ",
                    "value":"payed",
                    "customField":13
               }
            ],
            [
               {
                    "type":"LEAD_SCORE",
                    "relation":"GT",
                    "value":1000
               }
            ]
        ]
 }'
                

$.ajax({
    type: "PATCH",
    url: "https://api.automizy.com/segments/7",
    data:{
        name: "Updated",
        conditions: [
            [
               {
                    type:"EMAIL",
                    relation:"IN",
                    value:"@gmail."
               },
               {
                    type:"CUSTOM_FIELD",
                    relation:"EQ",
                    value:"payed",
                    customField:13
               }
            ],
            [
               {
                    type:"LEAD_SCORE",
                    relation:"GT",
                    value:1000
               }
            ]
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.segments().update({
    name: "Updated",
    conditions: [
        [
           {
                type:"EMAIL",
                relation:"IN",
                value:"@gmail."
           },
           {
                type:"CUSTOM_FIELD",
                relation:"EQ",
                value:"payed",
                customField:13
           }
        ],
        [
           {
                type:"LEAD_SCORE",
                relation:"GT",
                value:1000
           }
        ]
    ]
}, 7) //returns jqXHR
                

HTTP/1.1 200 OK
{
    "id": 7,
    "name": "Updated",
    "createDate": {
        "date": "2016-01-13 10:38:04",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "subscriberCount": 0,
    "conditions": [
        [{
            "type": "EMAIL",
            "relation": "IN",
            "value": "@gmail."
        }, {
            "type": "CUSTOM_FIELD",
            "relation": "EQ",
            "value": "payed",
            "customField": 62
        }],
        [{
            "type": "LEAD_SCORE",
            "relation": "GT",
            "value": 1000
        }]
    ],
    "_links": {
        "self": {
            "href": "https:\/\/api-dev.automizy.com\/segments\/7"
        },
        "calculate": {
            "href": "https:\/\/api-dev.automizy.com\/segments\/7\/calculate"
        },
        "contacts": {
            "href": "https:\/\/api-dev.automizy.com\/segments\/7\/contacts"
        }
    }
}
                

 $ curl 'https://api.automizy.com/newsletters' \
-X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
{
    "maxWidth":800,
        "tags":[
            "test",
            "bananas"
        ],
        "attachments":[10],
        "name": "My first test newsletter",
        "subject": "Free Bananas",
        "htmlCode": "<html><head></head><body><b>TEST</b></body></html>"
}'
                

$.ajax({
    type: "POST",
    url: "https://api.automizy.com/newsletters",
    data:{
        "maxWidth":800,
        "tags":[
            "test",
            "bananas"
        ],
        "attachments":[10],
        "name": "My first test newsletter",
        "subject": "Free Bananas",
        "htmlCode": "<html><head></head><body><b>TEST</b></body></html>"
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.newsletters().insert({
    "maxWidth":800,
        "tags":[
            "test",
            "bananas"
        ],
        "attachments":[10],
        "name": "My first test newsletter",
        "subject": "Free Bananas",
        "htmlCode": "<html><head></head><body><b>TEST</b></body></html>"
}); //returns jqXHR
                

HTTP/1.1 200 OK
{
    "id": 42,
    "name": "My first test newsletter",
    "subject": "Free Bananas",
    "createDate": {
        "date": "2016-01-13 13:59:29",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "updateDate": null,
    "editorCode": null,
    "htmlCode": "\u003Chtml\u003E\u003Chead\u003E\u003C\/head\u003E\u003Cbody\u003E\u003Cb\u003ETEST\u003C\/b\u003E\u003C\/body\u003E\u003C\/html\u003E",
    "hasBackup": false,
    "maxWidth": "800",
    "lastSendTime": null,
    "tags": ["test", "bananas"],
    "attachments": [{
        "id": 10,
        "name": "keres\u00e9s.txt",
        "_links": {
            "self": {
                "href": "https:\/\/api.automizy.com\/emails\/attachments\/10"
            }
        }
    }],
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/newsletters\/42"
        }
    }
}
                

$ curl 'https://api.automizy.com/newsletters/5' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/newsletters/5",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.newsletters().getRecordById(5) //returns jqXHR
                

HTTP/1.1 200 OK
{
    "id": 5,
    "name": "My first test newsletter",
    "subject": "Free Bananas",
    "createDate": {
        "date": "2016-01-13 13:59:29",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "updateDate": null,
    "editorCode": null,
    "htmlCode": "\u003Chtml\u003E\u003Chead\u003E\u003C\/head\u003E\u003Cbody\u003E\u003Cb\u003ETEST\u003C\/b\u003E\u003C\/body\u003E\u003C\/html\u003E",
    "hasBackup": false,
    "maxWidth": "800",
    "lastSendTime": null,
    "tags": ["test", "bananas"],
    "attachments": [{
        "id": 10,
        "name": "keres\u00e9s.txt",
        "_links": {
            "self": {
                "href": "https:\/\/api.automizy.com\/emails\/attachments\/10"
            }
        }
    }],
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/newsletters\/5"
        }
    }
}
                

#Filtering the collection where name contains the word 'test':
$ curl 'https://api.automizy.com/newsletters?where%5B0%5D%5B0%5D%5B0%5D=name&where%5B0%5D%5B0%5D%5B0%5D=like&where%5B0%5D%5B0%5D%5B0%5D=%test%' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/newsletters",
    data:{
        where:[
            [
                ['name', 'like', '%test%']
            ]
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.newsletters().where([
    [
        ["name", "like", "%test%"]
    ]
]).get() //returns jqXHR
                

HTTP/1.1 200 OK
{
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/newsletters?where%5B0%5D%5B0%5D%5B0%5D=name\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25test%25\u0026page=1"
        },
        "first": {
            "href": "https:\/\/api.automizy.com\/newsletters?where%5B0%5D%5B0%5D%5B0%5D=name\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25test%25"
        },
        "last": {
            "href": "https:\/\/api.automizy.com\/newsletters?where%5B0%5D%5B0%5D%5B0%5D=name\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25test%25\u0026page=1"
        }
    },
    "_embedded": {
        "newsletters": [{
            "id": 39,
            "name": "My first test newsletter",
            "subject": "Free Bananas",
            "createDate": {
                "date": "2016-01-13 13:51:48",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "updateDate": {
                "date": "2016-01-13 13:51:48",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "editorCode": null,
            "htmlCode": "\u0026lt;html\u003E\u0026lt;head\u003E\u0026lt;\/head\u003E\u0026lt;body\u003E\u0026lt;b\u003ETEST\u0026lt;\/b\u003E\u0026lt;\/body\u003E\u0026lt;\/html\u003E",
            "hasBackup": false,
            "maxWidth": 800,
            "lastSendTime": null,
            "tags": ["bananas", "test"],
            "attachments": [],
            "_links": {
                "self": {
                    "href": "https:\/\/api.automizy.com\/newsletters\/39"
                }
            }
        }]
    },
    "page_count": 1,
    "page_size": 9223372036854775807,
    "total_items": 1,
    "page": 1
}
                

 $ curl 'https://api.automizy.com/newsletters/5' \
-X DELETE \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "DELETE",
    url: "https://api.automizy.com/newsletters/5",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.newsletters().delete(5) //returns jqXHR
                

 $ curl 'https://api.automizy.com/newsletters/5' \
-X PATCH \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
    "subject": "Free Apples",
        "tags:" null
 }'
                

$.ajax({
    type: "PATCH",
    url: "https://api.automizy.com/newsletters/5",
    data:{
        "subject": "Free Apples",
        "tags:" null
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.newsletters().update({
    "subject": "Free Apples",
    "tags:" null
}, 5) //returns jqXHR
                

HTTP/1.1 200 OK
{
    "id": 5,
    "name": "My first test newsletter",
    "subject": "Free Apples",
    "createDate": {
        "date": "2016-01-13 13:59:29",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "updateDate": {
        "date": "2016-01-13 14:20:21",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "editorCode": null,
    "htmlCode": "\u003Chtml\u003E\u003Chead\u003E\u003C\/head\u003E\u003Cbody\u003E\u003Cb\u003ETEST\u003C\/b\u003E\u003C\/body\u003E\u003C\/html\u003E",
    "hasBackup": false,
    "maxWidth": "800",
    "lastSendTime": null,
    "tags": [],
    "attachments": [{
        "id": 10,
        "name": "keres\u00e9s.txt",
        "_links": {
            "self": {
                "href": "https:\/\/api.automizy.com\/emails\/attachments\/10"
            }
        }
    }],
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/newsletters\/5"
        }
    }
}
                

$ curl 'https://api.automizy.com/contacts' \
-X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
{
    "email":"testuser@example.com",
    "status":"ACTIVE",
    "customFields":{
        "birthday":"1989-03-03 00:00:00",
        "hobbies":[56,58]
    },
    "fixSegments": [2]
}'
                

$.ajax({
    type: "POST",
    url: "https://api.automizy.com/contacts",
    data:{
        "email":"testuser@example.com",
        "status":"ACTIVE",
        "customFields":{
            "birthday":"1989-03-03 00:00:00",
            "hobbies":[56,58]
        },
        "fixSegments": [2]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.contacts().insert({
    "email":"testuser@example.com",
    "status":"ACTIVE",
    "customFields":{
        "birthday":"1989-03-03 00:00:00",
        "hobbies":[56,58]
    },
    "fixSegments": [2]
});
                

HTTP/1.1 200 OK
{
    "id": 5,
    "email": "testuser@example.com",
    "status": "ACTIVE",
    "confirmedStatus": "CONFIRMED",
    "confirmDate": {
        "date": "2016-01-15 11:49:38",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "confirmIp": null,
    "requestDate": {
        "date": "2016-01-15 11:49:38",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "requestIp": null,
    "unsubscribeDate": null,
    "leadScore": {
        "total": 0,
        "scores": []
    },
    "fixSegments": {
        "2": "Test segment"
    },
    "tags":[],
    "customFields": {
        "name": null,
        "gender": null,
        "birthday": "1989-03-03 00:00:00",
        "hobbies":[56,58]
    },
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/contacts\/5"
        }
    }
}
                

#Filtering the collection where email ends with "@example.com":
$ curl 'https://api.automizy.com/contacts?where%5B0%5D%5B0%5D%5B0%5D=email&where%5B0%5D%5B0%5D%5B0%5D=like&where%5B0%5D%5B0%5D%5B0%5D=%@example.com' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/contacts",
    data:{
        where:[
            [
                ["email", "like", "%@example.com"]
            ]
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.contacts().where([
        [
            ["email", "like", "%@example.com"]
        ]
]).get() //returns jqXHR
                

HTTP/1.1 200 OK
{
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/contacts?where%5B0%5D%5B0%5D%5B0%5D=email\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25@example.com\u0026page=1"
        },
        "first": {
            "href": "https:\/\/api.automizy.com\/contacts?where%5B0%5D%5B0%5D%5B0%5D=email\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25@example.com"
        },
        "last": {
            "href": "https:\/\/api.automizy.com\/contacts?where%5B0%5D%5B0%5D%5B0%5D=email\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25@example.com\u0026page=1"
        }
    },
    "_embedded": {
        "contacts": [{
            "id": 5,
            "email": "testuser@example.com",
            "status": "ACTIVE",
            "confirmedStatus": "CONFIRMED",
            "confirmDate": {
                "date": "2016-01-15 11:49:38",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "confirmIp": null,
            "requestDate": {
                "date": "2016-01-15 11:49:38",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "requestIp": null,
            "unsubscribeDate": null,
            "leadScore": {
                "total": 0,
                "scores": []
            },
            "fixSegments": {
                "2": "Test segment"
            },
            "tags":[],
            "customFields": {
                "name": null,
                "gender": null,
                "birthday": "1989-03-03 00:00:00",
                "hobbies":[56,58]
            },
            "_links": {
                "self": {
                    "href": "https:\/\/api.automizy.com\/contacts\/5"
                }
            }
        }]
    },
    "page_count": 1,
    "page_size": 1000,
    "total_items": 1,
    "page": 1
}
                

$ curl 'https://api.automizy.com/contacts/5' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/contacts/5",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.contacts().getRecordById(5) //returns jqXHR
                

HTTP/1.1 200 OK
{
    "id": 5,
    "email": "testuser@example.com",
    "status": "ACTIVE",
    "confirmedStatus": "CONFIRMED",
    "confirmDate": {
        "date": "2016-01-15 11:49:38",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "confirmIp": null,
    "requestDate": {
        "date": "2016-01-15 11:49:38",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "requestIp": null,
    "unsubscribeDate": null,
    "leadScore": {
        "total": 0,
        "scores": []
    },
    "fixSegments": {
        "2": "Test segment"
    },
    "tags":[],
    "customFields": {
        "name": null,
        "gender": null,
        "birthday": "1989-03-03 00:00:00",
        "hobbies":[56,58]
    },
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/contacts\/5"
        }
    }
}
                

curl https://api.automizy.com/contacts/analyze-import -X POST -H 'Accept: application/json' -H 'Content-Type: multipart/form-data' -H 'Authorization: Bearer <ACCESS TOKEN>' -F 'import=@/tmp/file.csv'
                

HTTP/1.1 200 OK
{
   "headers": ["email", "name", "birthday"],
   "importId": "3.232",
   "aliveUntil": {
       "date": "2015-03-31 17:15:34",
       "timezone": "Europe/Budapest",
       "timezone_type": 3
   },
}
                

$ curl 'https://api.automizy.com/contacts/run-import' \
-X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
{
    "importId": 3.235,
    "override": false,
    "fields": [
        {
            "type": "customField",
            "operator": "override",
            "id": 76
        }
        {
            "id": null,
            "type": "email",
            "operator": "override"
        },
        {
            "id": null,
            "type": "status",
            "operator": "override"
        },
        {
            "id": null,
            "type": "isConfirmed",
            "operator": "override"
        }
    ],
    "create": true,
    "addContactTags":["tag1", "tag2"]
}'
                

$.ajax({
    type: "POST",
    url: "https://api.automizy.com/contacts/run-import",
    data: {
        "importId": 3.235,
        "override": false,
        "fields": [
            {
                "type": "customField",
                "operator": "override",
                "id": 76
            }
            {
                "id": null,
                "type": "email",
                "operator": "override"
            },
            {
                "id": null,
                "type": "status",
                "operator": "override"
            },
            {
                "id": null,
                "type": "isConfirmed",
                "operator": "override"
            }
        ],
        "create": true,
        "addContactTags":["tag1", "tag2"]
    },
    headers: {
        Authorization: 'Bearer ' + window.accessToken
    },
    success: function(data) {
        console.log(data)
    }
});
                

HTTP/1.1 200 OK
{
    "importId": "235",
    "analyzeId: "3.235"
}
                

$ curl 'https://api.automizy.com/contacts/5' \
-X DELETE \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "DELETE",
    url: "https://api.automizy.com/contacts/5",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.contacts().delete(5) //returns jqXHR
                

$ curl 'https://api.automizy.com/contacts/5' \
-X PATCH \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
                    -d '
{
    "email":"testuser@example.com",
    "status":"ACTIVE",
    "confirmationStatus": "CONFIRMED",
    "customFields":{
        "birthday":"1989-03-03 00:00:00",
        "hobbies":[56,58]
    },
    "fixSegments": [2],
    "addTags": ["abc", "dfe"],
    "removeTags": ["wasd"]
}'
                

$.ajax({
    type: "PATCH",
    url: "https://api.automizy.com/contacts/5",
    data:{
        "email":"testuser@example.com",
        "status":"ACTIVE",
        "confirmationStatus": "CONFIRMED",
        "customFields":{
            "birthday":"1989-03-03 00:00:00",
            "hobbies":[56,58]
        },
        "fixSegments": [2],
        "addTags": ["abc", "dfe"],
        "removeTags": ["wasd"]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.contacts().update({
    "email":"testuser@example.com",
    "status":"ACTIVE",
    "confirmationStatus": "CONFIRMED",
    "customFields":{
        "birthday":"1989-03-03 00:00:00",
        "hobbies":[56,58]
    },
    "fixSegments": [2]
    "addTags": ["abc", "dfe"],
    "removeTags": ["wasd"]
},5);
                

HTTP/1.1 200 OK
{
    "id": 5,
    "email": "testuser@example.com",
    "status": "ACTIVE",
    "confirmedStatus": "CONFIRMED",
    "confirmDate": {
        "date": "2016-01-15 11:49:38",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "confirmIp": null,
    "requestDate": {
        "date": "2016-01-15 11:49:38",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "requestIp": null,
    "unsubscribeDate": null,
    "leadScore": {
        "total": 0,
        "scores": []
    },
    "fixSegments": {
        "2": "Test segment"
    },
    "tags": [
        "abc",
        "dfe"
    ],
    "customFields": {
        "name": null,
        "gender": null,
        "birthday": "1989-03-03 00:00:00",
        "hobbies":[56,58]
    },
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/contacts\/5"
        }
    }
}
                

 $ curl 'https://api.automizy.com/custom-fields' \
-X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
	"name":"Multiple choices",
	"type":"MULTIPLE_CHOICES",
	"choices": [
		{
			"id": null,
			"value": "Option 1",
			"isDefault": true
		},
		{
			"id": null,
			"value": "Option 2",
			"isDefault": false
		},
		{
			"id": null,
			"value": "Option 3",
			"isDefault": true
		}
	]
}'
                

$.ajax({
    type: "POST",
    url: "https://api.automizy.com/custom-fields",
    data:{
        "name":"Multiple choices",
        "type":"MULTIPLE_CHOICES",
        "choices": [
            {
                "id": null,
                "value": "Option 1",
                "isDefault": true
            },
            {
                "id": null,
                "value": "Option 2",
                "isDefault": false
            },
            {
                "id": null,
                "value": "Option 3",
                "isDefault": true
            }
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.customFields().insert({
	"name":"Multiple choices",
	"type":"MULTIPLE_CHOICES",
	"choices": [
		{
			"id": null,
			"value": "Option 1",
			"isDefault": true
		},
		{
			"id": null,
			"value": "Option 2",
			"isDefault": false
		},
		{
			"id": null,
			"value": "Option 3",
			"isDefault": true
		}
	]
});
                

HTTP/1.1 200 OK
{
    "id": 83,
    "name": "multiple choices",
    "data": {
        "159": {
            "value": "Option 1",
            "isDefault": true
        },
        "160": {
            "value": "Option 2",
            "isDefault": false
        },
        "161": {
            "value": "Option 3",
            "isDefault": true
        }
    },
    "type": "MULTIPLE_CHOICES",
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/custom-fields\/83"
        }
    }
}
                

#Filtering the collection where name contains the word 'test':
$ curl 'https://api.automizy.com/custom-fields?where%5B0%5D%5B0%5D%5B0%5D=name&where%5B0%5D%5B0%5D%5B0%5D=like&where%5B0%5D%5B0%5D%5B0%5D=%test%' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/custom-fields",
    data:{
        where:[
            [
                ['name', 'like', '%test%']
            ]
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.customFields().where([
    [
        ["name", "like", "%test%"]
    ]
]).get() //returns jqXHR
                

HTTP/1.1 200 OK
{
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/custom-fields?where%5B0%5D%5B0%5D%5B0%5D=name\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25test%25\u0026page=1"
        },
        "first": {
            "href": "https:\/\/api.automizy.com\/custom-fields?where%5B0%5D%5B0%5D%5B0%5D=name\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25test%25"
        },
        "last": {
            "href": "https:\/\/api.automizy.com\/custom-fields?where%5B0%5D%5B0%5D%5B0%5D=name\u0026where%5B0%5D%5B0%5D%5B1%5D=like\u0026where%5B0%5D%5B0%5D%5B2%5D=%25test%25\u0026page=1"
        }
    },
    "_embedded": {
        "customFields": [{
            "id": 84,
            "name": "multiple choices test",
            "data": {
                "162": {
                    "value": "Option 1",
                    "isDefault": true
                },
                "163": {
                    "value": "Option 2",
                    "isDefault": false
                },
                "164": {
                    "value": "Option 3",
                    "isDefault": true
                }
            },
            "maxSelectionCount": -1,
            "type": "MULTIPLE_CHOICES",
            "_links": {
                "self": {
                    "href": "https:\/\/api.automizy.com\/custom-fields\/84"
                }
            }
        }, {
            "id": 85,
            "name": "text test",
            "data": "test",
            "type": "STRING",
            "_links": {
                "self": {
                    "href": "https:\/\/api.automizy.com\/custom-fields\/85"
                }
            }
        }]
    },
    "page_count": 1,
    "page_size": 9223372036854775807,
    "total_items": 2,
    "page": 1
}
                

$ curl 'https://api.automizy.com/custom-fields/83' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/custom-fields/83",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.customFields().getRecordById(83) //returns jqXHR
                

HTTP/1.1 200 OK
{
    "id": 83,
    "name": "multiple choices",
    "data": {
        "159": {
            "value": "Option 1",
            "isDefault": true
        },
        "160": {
            "value": "Option 2",
            "isDefault": false
        },
        "161": {
            "value": "Option 3",
            "isDefault": true
        }
    },
    "type": "MULTIPLE_CHOICES",
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/custom-fields\/83"
        }
    }
}
                

$ curl 'https://api.automizy.com/custom-fields/5' \
-X DELETE \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "DELETE",
    url: "https://api.automizy.com/custom-fields/5",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.customFields().delete(5) //returns jqXHR
                

 $ curl 'https://api.automizy.com/segments/83' \
-X PATCH \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
    "name":"Options",
    "choices": [
        {
            "id": 159,
            "value": "Option 1",
            "isDefault": true
        },
        {
            "id": 160,
            "value": "Option 2",
            "isDefault": false
        },
        {
            "id": 161,
            "value": "Option 3",
            "isDefault": false
        },
        {
            "id": null,
            "value": "Option 4",
            "isDefault": true
        }
    ]
}'
                

$.ajax({
    type: "POST",
    url: "https://api.automizy.com/custom-fields/83",
    data:{
    "name":"Options",
    "choices": [
        {
            "id": 159,
            "value": "Option 1",
            "isDefault": true
        },
        {
            "id": 160,
            "value": "Option 2",
            "isDefault": false
        },
        {
            "id": 161,
            "value": "Option 3",
            "isDefault": false
        },
        {
            "id": null,
            "value": "Option 4",
            "isDefault": true
        }
    ]
},
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.customFields().update({
    "name":"Options",
    "choices": [
        {
            "id": 159,
            "value": "Option 1",
            "isDefault": true
        },
        {
            "id": 160,
            "value": "Option 2",
            "isDefault": false
        },
        {
            "id": 161,
            "value": "Option 3",
            "isDefault": false
        },
        {
            "id": null,
            "value": "Option 4",
            "isDefault": true
        }
    ]
}, 83) //returns jqXHR
                

HTTP/1.1 200 OK
{
    "id": 83,
    "name": "options",
    "data": {
        "159": {
            "value": "Option 1",
            "isDefault": true
        },
        "160": {
            "value": "Option 2",
            "isDefault": false
        },
        "161": {
            "value": "Option 3",
            "isDefault": false
        },
        "162": {
            "value": "Option 4",
            "isDefault": true
        }
    },
    "type": "MULTIPLE_CHOICES",
    "_links": {
        "self": {
            "href": "https:\/\/api.automizy.com\/custom-fields\/83"
        }
    }
}
                

$ curl 'https://api.automizy.com/campaigns/7'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/campaigns/7",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.campaigns().getRecordById(7) //return jqXHR
                

HTTP/1.1 200 OK
{
	"id": 1,
	"name": "My E-mail Campaign",
	"embedImages": false,
	"sendFromName": "Automizy Admin",
	"sendFromEmail": "admin@automizy.com",
	"replyToEmail": "admin@automizy.com",
	"subject": "My first campaign",
	"htmlCode": "\u003C!DOCTYPE\u003E\u003Chtml.../html\u003E",
	"sendTime":
	{
		"date": "2016-01-28 16:40:57",
		"timezone_type": 3,
		"timezone": "Europe\/Budapest"
	},
	"finishedTime":
	{
		"date": "2016-01-28 16:41:00",
		"timezone_type": 3,
		"timezone": "Europe\/Budapest"
	},
	"segments": [
	{
		"id": 184,
		"filterType": "COMBINED",
		"name": "Test - 10",
		"createDate":
		{
			"date": "2016-01-18 16:05:44",
			"timezone_type": 3,
			"timezone": "Europe\/Budapest"
		},
		"subscriberCount": 10,
		"contactCount": 10,
		"contactLimit": 0,
		"conditions": [
			[
			{
				"type": "IMPORT_FILE",
				"relation": "IN",
				"value": "256"
			}]
		],
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/segments\/184"
			},
			"calculate":
			{
				"href": "https:\/\/api.automizy.com\/segments\/184\/calculate"
			},
			"contacts":
			{
				"href": "https:\/\/api.automizy.com\/segments\/184\/contacts"
			}
		}
	}],
	"clicks": 4,
	"opens": 3,
    "unsubscribes":0,
	"status": "FINISHED",
	"notificationEmail": "",
	"job":
	{
		"id": 1649,
		"name": "My E-mail Campaign",
		"progressCurrent": 10,
		"progressMax": 10,
		"started":
		{
			"date": "2016-01-28 16:40:57",
			"timezone_type": 3,
			"timezone": "Europe\/Budapest"
		},
		"finished":
		{
			"date": "2016-01-28 16:41:00",
			"timezone_type": 3,
			"timezone": "Europe\/Budapest"
		},
		"status": "FINISHED",
		"visibleUntil":
		{
			"date": "2016-01-28 16:51:00",
			"timezone_type": 3,
			"timezone": "Europe\/Budapest"
		},
		"type": "CAMPAIGN_SEND",
		"referenceId": 163,
		"parent": null,
		"isStoppable": false,
		"isPausable": false,
		"children": [],
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/jobs\/1649"
			}
		}
	},
	"links": [
	{
		"id": "1695",
		"url": "https:\/\/automizy.com",
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/campaigns\/1695"
			}
		}
	},
	{
		"id": "1697",
		"url": "[{webversion}]",
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/campaigns\/1697"
			}
		}
	}],
	"tags": [],
	"_links":
	{
		"self":
		{
			"href": "https:\/\/api.automizy.com\/campaigns\/1"
		}
	}
}
                

#Filtering the collection where name contains the word 'test':
$ curl 'https://api.automizy.com/campaigns?where%5B0%5D%5B0%5D%5B0%5D=name&where%5B0%5D%5B0%5D%5B0%5D=like&where%5B0%5D%5B0%5D%5B0%5D=%test%'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/campaigns",
    data:{
        where:[
            [
                ['name', 'like', '%test%']
            ]
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.campaigns().where([
    [
        ["name", "like", "%test%"]
    ]
]).get() //returns jqXHR
                

HTTP/1.1 200 OK
                    {
	"_links":
	{
		"self":
		{
			"href": "https:\/\/api.automizy.com\/campaigns?where[0][0][0]=name\u0026where[0][0][1]=like\u0026where[0][0][2]=%test%"
		}
	},
	"_embedded":
	{
		"campaigns": [{
            "id": 2,
            "name": "My Test Campaign",
            "embedImages": false,
            "sendFromName": "Automizy Admin",
            "sendFromEmail": "admin@automizy.com",
            "replyToEmail": "admin@automizy.com",
            "subject": "My first campaign",
            "htmlCode": "\u003C!DOCTYPE\u003E\u003Chtml.../html\u003E",
            "sendTime":
            {
                "date": "2016-01-28 16:40:57",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "finishedTime":
            {
                "date": "2016-01-28 16:41:00",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "segments": [
            {
                "id": 184,
                "filterType": "COMBINED",
                "name": "Test - 10",
                "createDate":
                {
                    "date": "2016-01-18 16:05:44",
                    "timezone_type": 3,
                    "timezone": "Europe\/Budapest"
                },
                "subscriberCount": 10,
                "contactCount": 10,
                "contactLimit": 0,
                "conditions": [
                    [
                    {
                        "type": "IMPORT_FILE",
                        "relation": "IN",
                        "value": "256"
                    }]
                ],
                "_links":
                {
                    "self":
                    {
                        "href": "https:\/\/api.automizy.com\/segments\/184"
                    },
                    "calculate":
                    {
                        "href": "https:\/\/api.automizy.com\/segments\/184\/calculate"
                    },
                    "contacts":
                    {
                        "href": "https:\/\/api.automizy.com\/segments\/184\/contacts"
                    }
                }
            }],
            "clicks": 4,
            "opens": 3,
            "unsubscribes" :0,
            "status": "FINISHED",
            "notificationEmail": "",
            "job":
            {
                "id": 1649,
                "name": "My Test Campaign",
                "progressCurrent": 10,
                "progressMax": 10,
                "started":
                {
                    "date": "2016-01-28 16:40:57",
                    "timezone_type": 3,
                    "timezone": "Europe\/Budapest"
                },
                "finished":
                {
                    "date": "2016-01-28 16:41:00",
                    "timezone_type": 3,
                    "timezone": "Europe\/Budapest"
                },
                "status": "FINISHED",
                "visibleUntil":
                {
                    "date": "2016-01-28 16:51:00",
                    "timezone_type": 3,
                    "timezone": "Europe\/Budapest"
                },
                "type": "CAMPAIGN_SEND",
                "referenceId": 163,
                "parent": null,
                "isStoppable": false,
                "isPausable": false,
                "children": [],
                "_links":
                {
                    "self":
                    {
                        "href": "https:\/\/api.automizy.com\/jobs\/1649"
                    }
                }
            },
            "links": [
            {
                "id": "1695",
                "url": "https:\/\/automizy.com",
                "_links":
                {
                    "self":
                    {
                        "href": "https:\/\/api.automizy.com\/campaigns\/1695"
                    }
                }
            },
            {
                "id": "1697",
                "url": "[{webversion}]",
                "_links":
                {
                    "self":
                    {
                        "href": "https:\/\/api.automizy.com\/campaigns\/1697"
                    }
                }
            }],
            "tags": [],
            "_links":
            {
                "self":
                {
                    "href": "https:\/\/api.automizy.com\/campaigns\/1"
                }
            }
        }]
	},
	"page_count": 0,
	"page_size": 9223372036854775807,
	"total_items": 0,
	"page": 0
}

                

 $ curl 'https://api.automizy.com/campaigns'' \
-X POST' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
    "newsletter": 3,
    "sendFromName": "Automizy",
    "sendFromEmail": "noreply@automizy.com",
    "sendTime": "2015-07-07 10:00:00",
    "replyToEmail": "noreply@automizy.com",
    "notificationEmail": "notifications@automizy.com",
    "segments": [1,2],
    "embedImages": true,
    "name":"My E-mail Campaign"
}'
                

$.ajax({
    type: "POST",
    url: "https://api.automizy.com/campaigns",
    data:{
        newsletter: 3,
        sendFromName: 'Automizy',
        sendFromEmail: 'noreply@automizy.com',
        sendTime: '2015-07-07 10:00:00',
        replyToEmail: 'noreply@automizy.com',
        notificationEmail: "notifications@automizy.com",
        segments: [1,2],
        embedImages: true,
        name:"My E-mail Campaign"
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.campaigns().insert({
    newsletter: 3,
    sendFromName: 'Automizy',
    sendFromEmail: 'noreply@automizy.com',
    sendTime: '2015-07-07 10:00:00',
    replyToEmail: 'noreply@automizy.com',
    notificationEmail: "notifications@automizy.com",
    segments: [1,2],
    embedImages: true,
    name:"My E-mail Campaign"
});
                

HTTP/1.1 200 OK
{
	"id": 1,
	"name": "My E-mail Campaign",
	"embedImages": true,
	"sendFromName": "Automizy Admin",
	"sendFromEmail": "admin@automizy.com",
	"replyToEmail": "admin@automizy.com",
	"subject": "My first campaign",
	"htmlCode": "\u003C!DOCTYPE\u003E\u003Chtml.../html\u003E",
	"sendTime":
	{
		"date": "2016-01-28 16:40:57",
		"timezone_type": 3,
		"timezone": "Europe\/Budapest"
	},
	"finishedTime": null,
	"segments": [
	{
		"id": 1,
		"filterType": "COMBINED",
		"name": "Test - 10",
		"createDate":
		{
			"date": "2016-01-18 16:05:44",
			"timezone_type": 3,
			"timezone": "Europe\/Budapest"
		},
		"subscriberCount": 10,
		"contactCount": 10,
		"contactLimit": 0,
		"conditions": [
			[
			{
				"type": "IMPORT_FILE",
				"relation": "IN",
				"value": "256"
			}]
		],
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/segments\/184"
			},
			"calculate":
			{
				"href": "https:\/\/api.automizy.com\/segments\/184\/calculate"
			},
			"contacts":
			{
				"href": "https:\/\/api.automizy.com\/segments\/184\/contacts"
			}
		}
	},
    {
        "id": 2,
        "filterType": "COMBINED",
        "name": "Test - 11",
        .
        .
        .
    }],
	"clicks": 0,
	"opens": 0,
    "unsubscribes": 0,
	"status": "SCHEDULED",
	"notificationEmail": "notifications@automizy.com",
	"job":
	{
		"id": 1649,
		"name": "My E-mail Campaign",
		"progressCurrent": 10,
		"progressMax": 10,
		"started":
		{
			"date": "2016-01-28 16:40:57",
			"timezone_type": 3,
			"timezone": "Europe\/Budapest"
		},
		"finished": null,
		"status": "SCHEDULED",
		"visibleUntil": null,
		"type": "CAMPAIGN_SEND",
		"referenceId": 163,
		"parent": null,
		"isStoppable": true,
		"isPausable": true,
		"children": [],
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/jobs\/1649"
			}
		}
	},
	"links": [
	{
		"id": "1695",
		"url": "https:\/\/automizy.com",
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/campaigns\/1695"
			}
		}
	},
	{
		"id": "1697",
		"url": "[{webversion}]",
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/campaigns\/1697"
			}
		}
	}],
	"tags": [],
	"_links":
	{
		"self":
		{
			"href": "https:\/\/api.automizy.com\/campaigns\/1"
		}
	}
}
                

 $ curl 'https://api.automizy.com/campaigns/3'' \
-X PATCH' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
    "newsletter": 3,
    "sendFromName": "Automizy",
    "sendFromEmail": "noreply@automizy.com",
    "sendTime": "2016-01-30 00:00:00",
    "replyToEmail": "noreply@automizy.com",
    "notificationEmail": "admin@automizy.com",
    "segments": [1],
    "embedImages": true
 }'
                

$.ajax({
    type: "PATCH",
    url: "https://api.automizy.com/campaigns/3",
    data:{
        newsletter: 3,
        sendFromName: 'Automizy',
        sendFromEmail: 'noreply@automizy.com',
        sendTime: "2016-01-30 00:00:00",
        replyToEmail: 'noreply@automizy.com',
        notificationEmail: "admin@automizy.com",
        segments: [1],
        embedImages: true
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.campaigns().update({
    newsletter: 3,
    sendFromName: 'Automizy',
    sendFromEmail: 'noreply@automizy.com',
    sendTime: "2016-01-30 00:00:00",
    replyToEmail: 'noreply@automizy.com',
    notificationEmail: "admin@automizy.com",
    segments: [1],
    embedImages: true
},3);
                

HTTP/1.1 200 OK
{
	"id": 1,
	"name": "My E-mail Campaign",
	"embedImages": true,
	"sendFromName": "Automizy Admin",
	"sendFromEmail": "admin@automizy.com",
	"replyToEmail": "admin@automizy.com",
	"subject": "My first campaign",
	"htmlCode": "\u003C!DOCTYPE\u003E\u003Chtml.../html\u003E",
	"sendTime":
	{
		"date": "2016-01-30 00:00:00",
		"timezone_type": 3,
		"timezone": "Europe\/Budapest"
	},
	"finishedTime": null,
	"segments": [
	{
		"id": 1,
		"filterType": "COMBINED",
		"name": "Test - 10",
		"createDate":
		{
			"date": "2016-01-18 16:05:44",
			"timezone_type": 3,
			"timezone": "Europe\/Budapest"
		},
		"subscriberCount": 10,
		"contactCount": 10,
		"contactLimit": 0,
		"conditions": [
			[
			{
				"type": "IMPORT_FILE",
				"relation": "IN",
				"value": "256"
			}]
		],
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/segments\/184"
			},
			"calculate":
			{
				"href": "https:\/\/api.automizy.com\/segments\/184\/calculate"
			},
			"contacts":
			{
				"href": "https:\/\/api.automizy.com\/segments\/184\/contacts"
			}
		}
	}],
	"clicks": 0,
	"opens": 0,
    "unsubscribes": 0,
	"status": "SCHEDULED",
	"notificationEmail": "admin@automizy.com",
	"job":
	{
		"id": 1649,
		"name": "My E-mail Campaign",
		"progressCurrent": 10,
		"progressMax": 10,
		"started":
		{
			"date": "2016-01-28 16:40:57",
			"timezone_type": 3,
			"timezone": "Europe\/Budapest"
		},
		"finished": null,
		"status": "SCHEDULED",
		"visibleUntil": null,
		"type": "CAMPAIGN_SEND",
		"referenceId": 163,
		"parent": null,
		"isStoppable": true,
		"isPausable": true,
		"children": [],
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/jobs\/1649"
			}
		}
	},
	"links": [
	{
		"id": "1695",
		"url": "https:\/\/automizy.com",
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/campaigns\/1695"
			}
		}
	},
	{
		"id": "1697",
		"url": "[{webversion}]",
		"_links":
		{
			"self":
			{
				"href": "https:\/\/api.automizy.com\/campaigns\/1697"
			}
		}
	}],
	"tags": [],
	"_links":
	{
		"self":
		{
			"href": "https:\/\/api.automizy.com\/campaigns\/1"
		}
	}
}
                

 $ curl 'https://api.automizy.com/campaigns/7/links'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/campaigns/7/links",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.campaigns().getLinksById(7);
                

HTTP/1.1 200 OK
{
    484: "http://automizy.com",
    485: "[{unsubscribelink}]",
    486: "[{webversion}]"
}
                

 $ curl 'https://api.automizy.com/campaigns/7/recipients'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/campaigns/7/recipients",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

//No Automizy JS Api function for this yet
                

HTTP/1.1 200 OK
{
    "items": [
      {
        "contact": {
          "id": 440063,
          "email": "john.doe@automizy.com"
        },
        "finished": true,
        "finishedAt": {
          "date": "2015-10-21 13:33:30",
          "timezone_type": 3,
          "timezone": "Europe\/Budapest"
        },
        "_links": {"self": {"href": "https:\/\/api.automizy.com\/campaigns\/76\/recipients"}}
      }
    ]
}
                

#Getting the open stats of the 7th campaign in total format, from 01/10/2015 to the current time:
$ curl 'https://api.automizy.com/campaigns/7/opens?format=total&from=2015.10.01+00%3A00%3A00&to=false'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'

#Gettining the recipients who opened the 7th campaign with additional fields
$ curl 'https://api.automizy.com/campaigns/1287/opens?links=&fields=email%2Cdate%2Cdevice%2Cbrowser%2Cos%2Ccountry%2Cregion%2Cip%2Cid&limit=10&page=1&order_dir=asc'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'


                

//Getting the open stats of the 7th campaign in total format, from 01/10/2015 to the current time:
$.ajax({
    url: 'https://api.automizy.com/campaigns/7/opens',
    type: 'GET',
    dataType: 'json',
    data: {
        format:"total",
        from:"2015.10.01 00:00:00",
        to:false
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});

//Gettining the recipients who opened the 7th campaign with additional fields
$.ajax({
    url: 'https://api.automizy.com/campaigns/7/opens',
    type: 'GET',
    dataType: 'json',
    data: {
        fields:"email,date,device,browser,os,country,region,ip,id",
        page:1,
        order:"email:asc"
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});

//What is the window.accessToken? You can see it in the Authentication section.
                

/*Getting the open stats of the 7th campaign, from 01/10/2015 to the current time:*/

//Total format:
$AA.campaigns().getOpenStatById(7,"2015.10.01 00:00:00",false);

//Timeline format:
$AA.campaigns().getOpenTimeLineById(7,"2015.10.01 00:00:00",false);

//Aggregate format:
$AA.campaigns().getOpenDevicePieById(7,"2015.10.01 00:00:00",false); //groupBy: "device"
$AA.campaigns().getOpenOsPieById(7,"2015.10.01 00:00:00",false); //groupBy: "os"
$AA.campaigns().getOpenBrowserPieById(7,"2015.10.01 00:00:00",false); //groupBy: "browser"
$AA.campaigns().getOpenDomainListById(7,"2015.10.01 00:00:00",false); //groupBy: "domain"

                

//Recipients who opened the campaign
{
    "_embedded":{
    "items": [
        {
            "id": "2571",
            "email": "john.doe@email.com",
            "date":
            {
                "date": "2016-06-20 12:01:48",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "device": "GOOGLE IMAGE PROXY",
            "os": "GOOGLE IMAGE PROXY",
            "browser": "GOOGLE IMAGE PROXY",
            "ip": "xxx.xxx.xxx.xxx",
            "country": "UNITED STATES",
            "region": "CALIFORNIA",
            "_links":
            {
                "self":
                {
                    "href": "https:\/\/api.automizy.com\/campaigns\/7\/opens"
                }
            }
        }
    ],
    "page_count": 2,
    "page_size": 10,
    "total_items": 1,
    "page": 1
}
                

HTTP/1.1 200 OK
//Total format example:
{
    total: 2,
    unique: 1
}
                

//Timeline format example:
{
    [
        //First timeframe
        {
            date:{
                    date: "15-05-06 02:08:44",
                    timezone_type:3,
                    timezone:"Europe\/Budapest"
            },
            value:{
                all:{
                    total: 1,
                    unique: 1
                }
            }
        },
        //Following timeframes
        {
            date:{
                    date: "15-05-06 03:10:15",
                    timezone_type:3,
                    timezone:"Europe\/Budapest"
            },
            value:{
                all:{
                    total: 3,
                    unique: 2
                }
            }
        },
        {},
        .
        .
        .
    ]
}
                

//Aggregate format example, groupBy: "browser"
{
    "Firefox": 2,
    "Chrome": 5,
    "Chrome Mobile": 3
}
                

#Getting the click stats of the 7th campaign in total format, from 01/10/2015 to the current time:
$ curl 'https://api.automizy.com/campaigns/7/clicks?format=total&from=2015.10.01+00%3A00%3A00&to=false'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'


#Gettining the recipients who clicked the 7th campaign with additional fields
$ curl 'https://api.automizy.com/campaigns/7/clicks?links=&fields=email%2Cdate%2Clink%2Cdevice%2Cbrowser%2Cos%2Ccountry%2Cregion%2Cip%2Cid&limit=10&page=1&order_dir=asc'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

//Getting the click stats of the 7th campaign in total format, from 01/10/2015 to the current time:
$.ajax({
    url: 'https://api.automizy.com/campaigns/7/clicks',
    type: 'GET',
    dataType: 'json',
    data: {
        format:"total",
        from:"2015.10.01 00:00:00",
        to:false
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});


//Gettining the recipients who clicked the 7th campaign with additional fields
$.ajax({
    url: 'https://api.automizy.com/campaigns/7/clicks',
    type: 'GET',
    dataType: 'json',
    data: {
        fields:"email,date,device,browser,os,country,region,ip,id",
        page:1,
        order:"email:asc"
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});
//What is the window.accessToken? You can see it in the Authentication section.
                

/*Getting the click stats of the 7th campaign, from 01/10/2015 to the current time:*/

//Total format:
$AA.campaigns().getClickStatById(7,"2015.10.01 00:00:00",false);

//Timeline format:
$AA.campaigns().getClickTimeLineById(7,"2015.10.01 00:00:00",false);

//Aggregate format:
$AA.campaigns().getClickDevicePieById(7,"2015.10.01 00:00:00",false); //groupBy: "device"
$AA.campaigns().getClickOsPieById(7,"2015.10.01 00:00:00",false); //groupBy: "os"
$AA.campaigns().getClickBrowserPieById(7,"2015.10.01 00:00:00",false); //groupBy: "browser"
$AA.campaigns().getClickDomainListById(7,"2015.10.01 00:00:00",false); //groupBy: "domain"
                

//Recipients who clicked the campaign
{
    "_embedded":{
    "items": [
        {
            "id": "2571",
            "email": "john.doe@email.com",
            "link":{
				"id": "2641",
				"url": "[{unsubscribelink}]"
			},
            "date":
            {
                "date": "2016-06-20 12:01:48",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "device": "GOOGLE IMAGE PROXY",
            "os": "GOOGLE IMAGE PROXY",
            "browser": "GOOGLE IMAGE PROXY",
            "ip": "xxx.xxx.xxx.xxx",
            "country": "UNITED STATES",
            "region": "CALIFORNIA",
            "_links":
            {
                "self":
                {
                    "href": "https:\/\/api.automizy.com\/campaigns\/7\/clicks"
                }
            }
        }
    ],
    "page_count": 2,
    "page_size": 10,
    "total_items": 1,
    "page": 1
}
                

HTTP/1.1 200 OK
//Total format example:
{
    total: 2,
    unique: 1
}
                

//Timeline format example:
{
    [
        //First timeframe
        {
            date :{
                    date: "15-05-06 02:08:44",
                    timezone_type:3,
                    timezone:"Europe\/Budapest"
            },
            value:{
                all: {
                    total: 1,
                    unique: 1
                }
            }
        },
        //Following timeframes
        {
            date :{
                    date: "15-05-06 03:10:15",
                    timezone_type:3,
                    timezone:"Europe\/Budapest"
            },
            value:{
                all: {
                    total: 3,
                    unique: 2
                }
            }
        },
        {},
        .
        .
        .
    ]
}
                

//Aggregate format example, groupBy: "browser"
{
    "Firefox": 2,
    "Chrome": 5,
    "Chrome Mobile": 3
}
                

#Getting the share stats of the 7th campaign from 01/10/2015 to the current time:
$ curl 'https://api.automizy.com/campaigns/7/shares?format=total&from=2015.10.01+00%3A00%3A00&to=false'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'

#Gettining the recipients who shared the 7th campaign with additional fields
$ curl 'https://api.automizy.com/campaigns/1287/shares?links=&fields=email%2Cdate%2CshareType%2Cdevice%2Cbrowser%2Cos%2Ccountry%2Cregion%2Cip%2Cid&limit=10&page=1&order_dir=asc'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    url: 'https://api.automizy.com/campaigns/7/shares',
    type: 'GET',
    dataType: 'json',
    data: {
        format:"total",
        from:"2015.10.01 00:00:00",
        to:false
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});

//Gettining the recipients who shared the 7th campaign with additional fields
$.ajax({
    url: 'https://api.automizy.com/campaigns/7/shares',
    type: 'GET',
    dataType: 'json',
    data: {
        fields:"email,date,shareType,device,browser,os,country,region,ip,id",
        page:1,
        order:"email:asc"
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});

//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.campaigns().getShareStatById(7,"2015.10.01 00:00:00",false);
                

HTTP/1.1 200 OK
//Total format example:
{
    total: 2,
    unique: 1
}
                

//Recipients who opened the campaign
{
    "_embedded":{
    "items": [
        {
            "id": "2571",
            "email": "john.doe@email.com",
            "date":
            {
                "date": "2016-06-20 12:01:48",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "shareType":"facebook",
            "device": "GOOGLE IMAGE PROXY",
            "os": "GOOGLE IMAGE PROXY",
            "browser": "GOOGLE IMAGE PROXY",
            "ip": "xxx.xxx.xxx.xxx",
            "country": "UNITED STATES",
            "region": "CALIFORNIA",
            "_links":
            {
                "self":
                {
                    "href": "https:\/\/api.automizy.com\/campaigns\/7\/shares"
                }
            }
        }
    ],
    "page_count": 2,
    "page_size": 10,
    "total_items": 18,
    "page": 1
}
                

#Getting the unsubscribe stats of the 7th campaign from 01/10/2015 to the current time:
$ curl 'https://api.automizy.com/campaigns/7/unsubscribes?format=total&from=2015.10.01+00%3A00%3A00&to=false'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'

#Gettining the recipients who unsubscribed from the 7th campaign with additional fields
$ curl 'https://api.automizy.com/campaigns/7/unsubscribes?links=&fields=email%2Cdate%2Cdevice%2Cbrowser%2Cos%2Ccountry%2Cregion%2Cip%2Cid&limit=10&page=1&order_dir=asc'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    url: 'https://api.automizy.com/campaigns/7/unsubscribes',
    type: 'GET',
    dataType: 'json',
    data: {
        format:"total",
        from:"2015.10.01 00:00:00",
        to:false
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});

//Gettining the recipients who shared the 7th campaign with additional fields
$.ajax({
    url: 'https://api.automizy.com/campaigns/7/shares',
    type: 'GET',
    dataType: 'json',
    data: {
        fields:"email,date,device,browser,os,country,region,ip,id",
        page:1,
        order:"email:asc"
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});

//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.campaigns().getUnsubscribeStatById(7,"2015.10.01 00:00:00",false);
                

HTTP/1.1 200 OK
//Total format example:
{
    total: 2
}
                

//Recipients who opened the campaign
{
    "_embedded":{
    "items": [
        {
            "id": "2571",
            "email": "john.doe@email.com",
            "date": {
                "date": "2016-06-20 12:01:52",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "device": "PC\/LAPTOP",
            "os": "WINDOWS",
            "browser": "CHROME",
            "ip": "xxx.xxx.xxx.xxx",
            "country": "HUNGARY",
            "region": "BUDAPEST"
            "_links":
            {
                "self":
                {
                    "href": "https:\/\/api.automizy.com\/campaigns\/7\/unsubscribes"
                }
            }
        }
    ],
    "page_count": 2,
    "page_size": 10,
    "total_items": 18,
    "page": 1
}
                

#Getting the bounce stats of the 7th campaign from 01/10/2015 to the current time:
$ curl 'https://api.automizy.com/campaigns/7/bounces?format=total&from=2015.10.01+00%3A00%3A00&to=false'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'

#Gettining the bounced recipients of the 7th campaign with additional fields
$ curl 'https://api.automizy.com/campaigns/7/bounces?links=&fields=email%2Cdate%2Ctype%2Ccode%2Cid&limit=10&page=1&order_dir=asc'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    url: 'https://api.automizy.com/campaigns/7/bounces',
    type: 'GET',
    dataType: 'json',
    data: {
        format:"total",
        from:"2015.10.01 00:00:00",
        to:false
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});

//Gettining the bounced recipients of the 7th campaign with additional fields
$.ajax({
    url: 'https://api.automizy.com/campaigns/7/bounces',
    type: 'GET',
    dataType: 'json',
    data: {
        fields:"email,date,type,code,id",
        page:1,
        order:"email:asc"
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});

//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.campaigns().getBounceStatById(7,"2015.10.01 00:00:00",false);
                

HTTP/1.1 200 OK
{
    hard: 2,
    soft: 1
}
                

//Recipients who bounced
{
    "_embedded":{
    "items": [
        {
            "id": "94",
            "email": "john.doe@email.com",
            "type": "SOFT",
            "date": {
                "date": "2016-06-20 12:02:46",
                "timezone_type": 3,
                "timezone": "Europe\/Budapest"
            },
            "code": "5.4.4",
            "_links":
            {
                "self":
                {
                    "href": "https:\/\/api.automizy.com\/campaigns\/7\/bounces"
                }
            }
        }
    ],
    "page_count": 2,
    "page_size": 10,
    "total_items": 18,
    "page": 1
}
                

#Getting the geo stats of the 7th campaign from 01/10/2015 to the current time:
$ curl 'https://api.automizy.com/campaigns/7/geo-locations?format=raw&from=2015.10.01+00%3A00%3A00&to=false'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    url: 'https://api.automizy.com/campaigns/7/geo-locations',
    type: 'GET',
    dataType: 'json',
    data: {
        format:"raw",
        from:"2015.10.01 00:00:00",
        to:false
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.campaigns().getGeoStatById(7,"2015.10.01 00:00:00",false);
                

HTTP/1.1 200 OK
[
    {
        count: "1",
        country: "HUNGARY",
        region: "BUDAPEST"
    },
    {
        count: "3",
        country: "USA",
        region: "FLORIDA"
    }
]
                

#Getting the geo stats of the 7th campaign from 01/10/2015 to the current time:
$ curl 'https://api.automizy.com/campaigns/7/heat-map?format=raw&from=2015.10.01+00%3A00%3A00&to=false'' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    url: 'https://api.automizy.com/campaigns/7/heat-map',
    type: 'GET',
    dataType: 'json',
    data: {
        format:"raw",
        from:"2015.10.01 00:00:00",
        to:false
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.campaigns().getHeatMapById(7,"2015.10.01 00:00:00",false);
                

HTTP/1.1 200 OK
[
    {
    "url": "http:\/\/automizy.com",
    "count": "0",
    "distinctCount": "0"
    },
    {
    "url": "[{confirmlink}]",
    "count": "0",
    "distinctCount": "0"
    },
    {
    "url": "[{webversion}]",
    "count": "2",
    "distinctCount": "2"
    }
]
                

#Getting combined statistics of the first campaign
$ curl 'https://api.automizy.com/campaigns/1/combined'' \
-X POST' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
    "open": {
        "type":"open",
        "format":"total",
        "from": "2015.11.01",
        "to": "2015.11.10"
    },
    "deviceOpenPie": {
        "type":"open",
        "format":"aggregate",
        "groupBy": "device",
        "from": "2015.11.01",
        "to": "2015.11.10"
    },
    "geoChart": {
        "type:"geo-location",
        "format":"raw",
        "from": "2015.11.01",
        "to": "2015.11.10"
    }
}'
                

$.ajax({
    url: 'https://api.automizy.com/campaigns/1/combined',
    type: 'POST',
    dataType: 'json',
    data: {
        "open": {
            "type":"open",
            "format":"total",
            "from": "2015.11.01",
            "to": "2015.11.10"
        },
        "deviceOpenPie": {
            "type":"open",
            "format":"aggregate",
            "groupBy": "device",
            "from": "2015.11.01",
            "to": "2015.11.10"
        },
        "geoChart": {
            "type":"geo-location",
            "format":"raw",
            "from": "2015.11.01",
            "to": "2015.11.10"
    },
    headers: {Authorization: 'Bearer ' + window.accessToken}
});
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.campaigns().getCombinedById(1, {
    open: {
        type:'open',
        format:'total',
        from: "2015.11.01",
        to: "2015.11.10"
    },
   deviceOpenPie: {
        type:"open",
        format:"aggregate",
        groupBy: "device",
        from: "2015.11.01",
        to: "2015.11.10"
    },
    geoChart: {
        type:'geo-location',
        format:'raw',
        from: "2015.11.01",
        to: "2015.11.10"
    }
});
                

HTTP/1.1 200 OK
{
    deviceOpenPie: {
        "PC\/Laptop": 10,
        "Mobile": 3
    },
    geoChart: [
        {
            count: "4",
            country: "HUNGARY",
            region: "BUDAPEST"
        },
        {
            count: "9",
            country: "USA",
            region: "FLORIDA"
        }
    ],
    open:{
        total: 13,
        unique: 8
    }
}
                

||Getting the contacts who opened a campaign between 2016-07-12 15:00:00 and 2016-07-12 15:20:00

$ curl 'https://api.automizy.com/campaigns/globalStatistics/open?from=2016-07-12+15%3A00%3A00&to=2016-07-12+15%3A20%3A00&showContent=1' \
-X GET \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

//Getting the contacts who opened a campaign between 2016-07-12 15:00:00 and 2016-07-12 15:20:00

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/campaigns/globalStatistics/open",
    data: {
        "from": "2016-07-12 15:00:00",
        "to": "2016-07-12 15:20:00",
        "showContent": 1
    },
    headers: {
        Authorization: 'Bearer ' + window.accessToken
    },
    success: function(data) {
        console.log(data)
    }
});
                

"Contact email";"Open date";"Campaign name"
"john.doe@gmail.com";"2016-07-12 15:14:00";"My campaign"
"jane.doe@gmail.com";"2016-07-12 15:16:00";"My campaign2"
                

$ curl 'https://api.automizy.com/split-tests' \
-X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
    'name': 'My first split test',
    'conditionCheckDelay': {
        'days': 1,
        'hours': 2,
        'minutes': 30
    },
    'sendTime': '2015-06-22 14:00:00',
    'percentage': 10,
    'winAction': 'SEND_REMAINING',
    'winCondition': 'MOST_LINK_CLICK',
    'segments': [1,4,10],
    'newsletters': [
        {
            'newsletter': 3,
            'name': 'Third campaign',
            'embedImages': true,
            'sendFromEmail': 'myemail@mymail.com',
            'replyToEmail': 'myemail@mymail.com',
            'sendFromName': 'John Doe',
        },
        {
            'newsletter': 4,
            'name': 'Fourth campaign',
            'embedImages': false,
            'sendFromEmail': 'myemail@mymail.com',
            'replyToEmail': 'myemail@mymail.com',
            'sendFromName': 'John Doe',
        }
    ]
 }'
                

$.ajax({
    type: "POST",
    url: "https://api.automizy.com/split-tests",
    data:{
        name: 'My first split test',
        conditionCheckDelay: {
        //The test will run for 1 days, 2 hours and 30 minutes
            days: 1,
            hours: 2,
            minutes: 30
        },
        sendTime: '2015-06-22 14:00:00',
        percentage: 10,
        winAction: 'SEND_REMAINING',
        winCondition: 'MOST_LINK_CLICK',
        segments: [1,4,10],
        newsletters: [
            {
                newsletter: 3, //id
                name: 'Third campaign',
                embedImages: true,
                sendFromEmail: 'myemail@mymail.com',
                replyToEmail: 'myemail@mymail.com',
                sendFromName: 'John Doe',
            },
            {
                newsletter: 4, //id
                name: 'Fourth campaign',
                embedImages: false,
                sendFromEmail: 'myemail@mymail.com',
                replyToEmail: 'myemail@mymail.com',
                sendFromName: 'John Doe',
            }
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.splitTests().send({
    name: 'My first split test',
    conditionCheckDelay: {
    //The test will run for 1 days, 2 hours and 30 minutes
        days: 1,
        hours: 2,
        minutes: 30
    },
    sendTime: '2015-06-22 14:00:00',
    percentage: 10,
    winAction: 'SEND_REMAINING',
    winCondition: 'MOST_LINK_CLICK',
    segments: [1,4,10],
    newsletters: [
        {
            newsletter: 3, //id
            name: 'Third campaign',
            embedImages: true,
            sendFromEmail: 'myemail@mymail.com',
            replyToEmail: 'myemail@mymail.com',
            sendFromName: 'John Doe',
        },
        {
            newsletter: 4, //id
            name: 'Fourth campaign',
            embedImages: false,
            sendFromEmail: 'myemail@mymail.com',
            replyToEmail: 'myemail@mymail.com',
            sendFromName: 'John Doe',
        }
    ]
});
                

HTTP/1.1 200 OK
{
    _links: Object,
    campaigns: Array[2],
    conditionCheck: null,
    firstConditionCheck: {
        days: 1,
        hours: 2,
        minutes: 30,
    },
    id: "36",
    job: Object,
    name: "My first split test",
    percentage: 10,
    status: "WAIT_UNTIL_SCHEDULE_TIME",
    winAction: "SEND_REMAINING",
    winCondition: "MOST_LINK_CLICK",
    winner: null
}
                

 $ curl 'https://api.automizy.com/templates' \
-X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
{
    "name": "My first test template",
    "htmlCode": "<html><head></head><body><b>TEST</b></body></html>"
}'
                

$.ajax({
    type: "POST",
    url: "https://api.automizy.com/template",
    data:{
        "name": "My first test template",
        "htmlCode": "<html><head></head><body><b>TEST</b></body></html>"
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.templates().insert({
    "name": "My first test template",
    "htmlCode": "<html><head></head><body><b>TEST</b></body></html>"
}); //returns jqXHR
                

HTTP/1.1 200 OK
{
   "id": 6,
   "name": "My first test template",
   "createDate": {
       "date": "2015-03-31 17:15:34",
       "timezone": "Europe/Budapest",
       "timezone_type": 3
   },
   "editorCode": "",
   "htmlCode": "<html><head></head><body><b>TEST</b></body></html>",
   "hasBackup": false,
   "maxWidth": 650,
   "previewUrl": "https://img-dev.automizy.com/a3f719582a7f156d14ae33653504344f/preview/templates/286.jpg"
}
                

$ curl 'https://api.automizy.com/templates/5' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/templates/5",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.templates().getRecordById(5) //returns jqXHR
                

HTTP/1.1 200 OK
{
   "id": 6,
   "name": "My first test template",
   "createDate": {
       "date": "2015-03-31 17:15:34",
       "timezone": "Europe/Budapest",
       "timezone_type": 3
   },
   "editorCode": "",
   "htmlCode": "<html><head></head><body><b>TEST</b></body></html>",
   "hasBackup": false,
   "maxWidth": 650,
   "previewUrl": "https://img-dev.automizy.com/a3f719582a7f156d14ae33653504344f/preview/templates/286.jpg"
}
                

#Filtering the collection where name contains the word 'test':
$ curl 'https://api.automizy.com/templates?where%5B0%5D%5B0%5D%5B0%5D=name&where%5B0%5D%5B0%5D%5B0%5D=like&where%5B0%5D%5B0%5D%5B0%5D=%test%' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/templates",
    data:{
        where:[
            [
                ['name', 'like', '%test%']
            ]
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.templates().where([
    [
        ["name", "like", "%test%"]
    ]
]).get() //returns jqXHR
                

HTTP/1.1 200 OK
{
	"_links":
	{
		"self":
		{
			"href": "https:\/\/api.automizy.com\/templates?page=1"
		},
		"first":
		{
			"href": "https:\/\/api.automizy.com\/templates"
		},
		"last":
		{
			"href": "https:\/\/api.automizy.com\/templates?page=1"
		}
	},
	"_embedded":
	{
		"templates": [
		{
			"id": 35,
			"previewUrl": "https:\/\/img.automizy.com\/0a13431cad9c81709b2a4d0767d18190\/preview\/templates\/35.jpg",
			"name": "alma",
			"createDate":
			{
				"date": "2015-06-12 16:51:41",
				"timezone_type": 3,
				"timezone": "Europe\/Budapest"
			},
			"editorCode": "\u003Cdiv class=\u0022noblock\u0022\u003EDrag an item from the left side and drop it here!\u003C\/div\u003E\u003Cdiv class=\u0022pee-block\u0022 data-name=\u0022image\u0022 data-type=\u0022content\u0022\u003E\u003Cdiv class=\u0022pee-block-head ui-sortable-handle\u0022 style=\u0022display: none;\u0022\u003E\u003C\/div\u003E\u003Cdiv class=\u0022pee-block-settings\u0022 data-title=\u0022Block settings\u0022 style=\u0022display: none;\u0022\u003E\u003C\/div\u003E\u003Cdiv class=\u0022pee-block-copy\u0022 data-title=\u0022Copy this block\u0022 style=\u0022display: none;\u0022\u003E\u003C\/div\u003E\u003Cdiv class=\u0022pee-block-bgcolor\u0022 data-title=\u0022Background color\u0022 style=\u0022display: none;\u0022\u003E\u003C\/div\u003E\u003Cdiv class=\u0022pee-block-delete\u0022 data-title=\u0022Delete this block\u0022 style=\u0022display: none;\u0022\u003E\u003C\/div\u003E\n                    \n                    \u003Cdiv class=\u0022pee-block-content\u0022 style=\u0022background-color: rgb(255, 255, 255);\u0022\u003E\n                        \u003Cdiv align=\u0022center\u0022 class=\u0022pee-block-content-image imagein nocontrol\u0022 data-max-img-width=\u0022100%\u0022 data-fileid=\u00221_w9xiq0rpptlfw8jr\u0022\u003E\n                            \u003Cdiv align=\u0022center\u0022 class=\u0022control\u0022\u003E\u003Cimg src=\u0022vendor\/emaileditor\/images\/pee-sample.jpg\u0022 class=\u0022\u0022 data-width-in-percent=\u00220\u0022\u003E\u003C\/div\u003E\n                            \u003Cdiv align=\u0022center\u0022 class=\u0022control\u0022\u003E\u003Cinput type=\u0022button\u0022 value=\u0022Select image\u0022 class=\u0022simple-button\u0022\u003E\u003C\/div\u003E\n                        \u003Cdiv class=\u0022progressbar-box\u0022\u003E\u003Cdiv class=\u0022progressbar\u0022\u003E\u003C\/div\u003E\u003C\/div\u003E\u003Cdiv class=\u0022ui-wrapper\u0022 style=\u0022overflow: hidden; position: relative; width: 488px; height: 500px; top: auto; left: auto; margin: 0px; display: inline-block;\u0022\u003E\u003Cimg src=\u0022https:\/\/img.automizy.com\/0a13431cad9c81709b2a4d0767d18190\/emaileditor\/a26dd331e0af620cf1da2710912b2bf7c47cdefd.jpg\u0022 data-fileid=\u00220rp1r0olaqv6ajor\u0022 style=\u0022padding: 0px; margin: 0px; min-width: 0px; max-width: 100%; resize: none; position: static; zoom: 1; display: block; height: 500px; width: 488px;\u0022 alt=\u0022\u0022 data-href=\u0022http:\/\/\u0022 title=\u0022\u0022 class=\u0022ui-resizable\u0022 data-width-in-percent=\u002278\u0022\u003E\u003Cdiv class=\u0022ui-resizable-handle ui-resizable-e\u0022 style=\u0022z-index: 90;\u0022\u003E\u003C\/div\u003E\u003Cdiv class=\u0022ui-resizable-handle ui-resizable-s\u0022 style=\u0022z-index: 90;\u0022\u003E\u003C\/div\u003E\u003Cdiv class=\u0022ui-resizable-handle ui-resizable-se ui-icon ui-icon-gripsmall-diagonal-se\u0022 style=\u0022z-index: 90;\u0022\u003E\u003C\/div\u003E\u003C\/div\u003E\u003C\/div\u003E\n                    \u003C\/div\u003E\n                \u003C\/div\u003E\u003Cdiv class=\u0022pee-info-block\u0022 data-style-padding-top=\u00220px\u0022 data-style-padding-bottom=\u00220px\u0022 data-style-padding-left=\u00220%\u0022 data-style-padding-right=\u00220%\u0022 data-style-background-color=\u0022#eef4e6\u0022 data-style-border-color=\u0022#d7d7d7\u0022 data-style-border-width=\u00220px\u0022 data-style-max-width=\u0022650px\u0022\u003E\u003C\/div\u003E",
			"htmlCode": "\u003Chtml\u003E\u003Chead\u003E\u003Ctitle\u003Ealma\u003C\/title\u003E\u003Cmeta http-equiv=\u0022Content-Type\u0022 content=\u0022text\/html; charset=utf-8\u0022\u003E\u003Cmeta property=\u0022og:title\u0022 content=\u0022alma\u0022 \/\u003E\u003Cmeta property=\u0022og:description\u0022 content=\u0022...\u0022 \/\u003E\u003Cmeta property=\u0022og:type\u0022 content=\u0022website\u0022 \/\u003E\u003Cmeta property=\u0022og:url\u0022 content=\u0022%%webversion%%\u0022 \/\u003E\u003Cmeta property=\u0022og:image\u0022 content=\u0022https:\/\/www.automizy.com\/images\/editor-share-300x300.jpg\u0022 \/\u003E\u003Cstyle\u003E@media only screen and (max-width: 480px) {.column2{width: 100% !important;}}\u003C\/style\u003E\u003C\/head\u003E\u003Cbody align=\u0022center\u0022 width=\u0022100%\u0022 bgcolor=\u0022#eef4e6\u0022 style=\u0022text-align:center; width:100%; background-color:#eef4e6\u0022\u003E\u003Cdiv align=\u0022center\u0022 width=\u0022100%\u0022 bgcolor=\u0022#eef4e6\u0022 style=\u0022text-align:center; width:100%; background-color:#eef4e6\u0022\u003E\u003C!--[if mso]\u003E\u003Cdiv align=\u0022center\u0022 class=\u0022outlook\u0022 style=\u0022text-align:center\u0022\u003E\u003Ctable cellpadding=\u00220\u0022 cellspacing=\u00220\u0022 border=\u00220\u0022 width=\u0022650px\u0022 style=\u0022width:650px\u0022\u003E\u003Ctr\u003E\u003Ctd\u003E\u003C![endif]--\u003E\u003Ctable cellpadding=\u00220\u0022 cellspacing=\u00220\u0022 border=\u00220\u0022 style=\u0022width:100%; border:0px solid rgb(215, 215, 215); background-color:rgb(238, 244, 230); max-width:650px; margin:0 auto 0 auto; padding:0\u0022\u003E\u003Ctbody\u003E\u003Ctr\u003E\u003Ctd style=\u0022padding-top:0px; padding-bottom:0px; padding-left:0%; padding-right:0%\u0022\u003E\u003Cdiv\u003E\n                    \n                    \u003Ctable cellpadding=\u00220\u0022 cellspacing=\u00220\u0022 border=\u00220\u0022 width=\u0022100%\u0022 style=\u0022padding:0; margin:0; width:100%\u0022\u003E\u003Ctbody\u003E\u003Ctr\u003E\u003Ctd style=\u0022background-color:#ffffff;color:#000000;padding-top:12px;padding-right:16px;padding-bottom:12px;padding-left:16px;font-size:16px;font-family:Arial;clear:both;\u0022\u003E\n                        \u003Cdiv align=\u0022center\u0022 style=\u0022color:#000000;padding-top:0px;padding-right:0px;padding-bottom:0px;padding-left:0px;font-size:0px;font-family:Arial;vertical-align:top;text-align:center;\u0022\u003E\n                            \n                            \n                        \u003Cdiv style=\u0022color: rgb(0, 0, 0); padding: 0px; font-size: 0px; font-family: Arial; width: 100%; text-align: center;\u0022\u003E\u003Cimg src=\u0022https:\/\/img.automizy.com\/0a13431cad9c81709b2a4d0767d18190\/emaileditor\/a26dd331e0af620cf1da2710912b2bf7c47cdefd.jpg\u0022 style=\u0022max-width:78%\u0022 alt=\u0022\u0022 title=\u0022\u0022 data-width-in-percent=\u002278\u0022 width=\u0022488\u0022 data-mso-width=\u0022488\u0022 data-mso-height=\u0022500\u0022 data-img-id=\u00220\u0022\u003E\u003C\/img\u003E\u003C\/div\u003E\u003C\/div\u003E\n                    \u003C\/td\u003E\u003C\/tr\u003E\u003C\/tbody\u003E\u003C\/table\u003E\n                \u003C\/div\u003E\u003Cdiv class=\u0022pee-info-block\u0022 data-style-padding-top=\u00220px\u0022 data-style-padding-bottom=\u00220px\u0022 data-style-padding-left=\u00220%\u0022 data-style-padding-right=\u00220%\u0022 data-style-background-color=\u0022#eef4e6\u0022 data-style-border-color=\u0022#d7d7d7\u0022 data-style-border-width=\u00220px\u0022 data-style-max-width=\u0022650px\u0022\u003E\u003C\/div\u003E\u003C\/td\u003E\u003C\/tr\u003E\u003C\/tbody\u003E\u003C\/table\u003E\u003C!--[if mso]\u003E\u003C\/td\u003E\u003C\/tr\u003E\u003C\/table\u003E\u003C\/div\u003E\u003C![endif]--\u003E\u003C\/div\u003E\u003C\/body\u003E\u003C\/html\u003E",
			"hasBackup": false,
			"maxWidth": 650,
			"_links":
			{
				"self":
				{
					"href": "https:\/\/api.automizy.com\/templates\/35"
				}
			}
		}]
	},
	"page_count": 1,
	"page_size": 9223372036854775807,
	"total_items": 1,
	"page": 1
}
                

 $ curl 'https://api.automizy.com/templates/5' \
-X DELETE \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "DELETE",
    url: "https://api.automizy.com/templates/5",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.templates().delete(5) //returns jqXHR
                

 $ curl 'https://api.automizy.com/templates/5' \
-X PATCH \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
    "name": "Renamed template"
 }'
                

$.ajax({
    type: "PATCH",
    url: "https://api.automizy.com/templates/5",
    data:{
        "name": "Renamed template"
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.templates().update({
    "name": "Renamed template"
}, 7) //returns jqXHR
                

HTTP/1.1 200 OK
{
   "id": 6,
   "name": "Renamed template"
   "createDate": {
       "date": "2015-03-31 17:15:34",
       "timezone": "Europe/Budapest",
       "timezone_type": 3
   },
   "editorCode": "",
   "htmlCode": "<html><head></head><body><b>TEST</b></body></html>",
   "hasBackup": false,
   "maxWidth": 650,
   "previewUrl": "https://img-dev.automizy.com/a3f719582a7f156d14ae33653504344f/preview/templates/286.jpg"
}
                

#Filtering the collection where name contains the word 'test':
$ curl 'https://api.automizy.com/users?where%5B0%5D%5B0%5D%5B0%5D=name&where%5B0%5D%5B0%5D%5B0%5D=like&where%5B0%5D%5B0%5D%5B0%5D=%test%' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/users",
    data:{
        where:[
            [
                ['name', 'like', '%test%']
            ]
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.users().where([
    [
        ["name", "like", "%test%"]
    ]
]).get() //returns jqXHR
                

HTTP/1.1 200 OK
{
	"_links":
	{
		"self":
		{
			"href": "https:\/\/api.automizy.com\/users?page=1"
		},
		"first":
		{
			"href": "https:\/\/api.automizy.com\/users"
		},
		"last":
		{
			"href": "https:\/\/api.automizy.com\/users?page=1"
		}
	},
	"_embedded":
	{
		"users": [
		{
			"id": "U-664",
			"status": "active",
			"email": "john.doe@gmail.com",
			"date": "2016-01-22 20:23:23",
			"firstName": "John",
			"lastName": "Doe",
			"_links":
			{
				"self":
				{
					"href": "https:\/\/api.automizy.com\/users\/U-664"
				}
			}
		}]
	},
	"page_count": 1,
	"page_size": 9223372036854775807,
	"total_items": 1,
	"page": 1
}
                

$ curl 'https://api.automizy.com/users/current' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/users/current",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.users().getRecordById('current') //returns jqXHR
                

HTTP/1.1 200 OK
{
	"id": "18",
	"firstName": "John",
	"lastName": "Doe",
	"timeZone": "Europe\/Budapest GMT +01:00",
	"registrationTime":
	{
		"date": "2015-05-05 12:24:51",
		"timezone_type": 3,
		"timezone": "Europe\/Budapest"
	},
	"language": "en_US",
	"userName": "john.doe@gmail.com",
	"sites":
	{

		"578":
		{
			"company": "John Ltd."
		}
	},
	"characterEncoding": "ISO-8859-2",
	"fieldSeparator": ";",
	"fieldEnclosure": "\u0022",
	"currentSite": 578,
	"company": "johnltd",
	"intercomHash": "c033df58fcb078744d63aa40aacd9b056036fe3114b",
	"isAdmin": false,
	"_links":
	{
		"self":
		{
			"href": "https:\/\/api.automizy.com\/users\/18"
		}
	}
}
                

$ curl 'https://api.automizy.com/users/18' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/users/18",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.users().getRecordById(18) //returns jqXHR
                

HTTP/1.1 200 OK
{
	"id": "18",
	"firstName": "John",
	"lastName": "Doe",
	"timeZone": "Europe\/Budapest GMT +01:00",
	"registrationTime":
	{
		"date": "2015-05-05 12:24:51",
		"timezone_type": 3,
		"timezone": "Europe\/Budapest"
	},
	"language": "en_US",
	"userName": "john.doe@gmail.com",
	"sites":
	{

		"578":
		{
			"company": "John Ltd."
		}
	},
	"characterEncoding": "ISO-8859-2",
	"fieldSeparator": ";",
	"fieldEnclosure": "\u0022",
	"currentSite": 578,
	"company": "johnltd",
	"intercomHash": "c033df58fcb078744d63aa40aacd9b056036fe3114b",
	"isAdmin": false,
	"_links":
	{
		"self":
		{
			"href": "https:\/\/api.automizy.com\/users\/18"
		}
	}
}
                

$ curl 'https://api.automizy.com/users/supported-time-zones' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/users/supported-time-zones",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

//No Automizy JS Api function for this yet
                

HTTP/1.1 200 OK
{
    [
        "Africa/Abidjan GMT +00:00",
        "Africa/Accra GMT +00:00",
        "Africa/Addis_Ababa GMT +03:00",
        .
        .
        .
    ]
}
                

#Filtering the collection where name contains the word 'test':
$ curl 'https://api.automizy.com/jobs?where%5B0%5D%5B0%5D%5B0%5D=name&where%5B0%5D%5B0%5D%5B0%5D=like&where%5B0%5D%5B0%5D%5B0%5D=%test%' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/jobs",
    data:{
        where:[
            [
                ['name', 'like', '%test%']
            ]
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.jobs().where([
    [
        ["name", "like", "%test%"]
    ]
]).get() //returns jqXHR
                

HTTP/1.1 200 OK
                    {
	"_links":
	{
		"self":
		{
			"href": "https:\/\/api.automizy.com\/jobs?where[0][0][0]=name\u0026where[0][0][1]=like\u0026where[0][0][2]=%test%"
		}
	},
	"_embedded":
	{
		"jobs": [{
			"id": 2926,
			"name": "My test campaign 2016. 05. 13. 16:39:25",
			"progressCurrent": 0,
			"progressMax": 2,
			"started":
			{
				"date": "2016-05-18 14:46:13",
				"timezone_type": 3,
				"timezone": "Europe\/Budapest"
			},
			"finished": null,
			"status": "CONTACT_LIMIT_REACHED",
			"visibleUntil": null,
			"type": "CAMPAIGN_SEND",
			"referenceId": 706,
			"parent": null,
			"isStoppable": true,
			"isPausable": true,
			"children": [],
			"_links":
			{
				"self":
				{
					"href": "https:\/\/api.automizy.com\/jobs\/2926"
				}
			}
		}]
	},
	"page_count": 0,
	"page_size": 9223372036854775807,
	"total_items": 0,
	"page": 0
}

                

$ curl 'https://api.automizy.com/jobs/7' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/jobs/7",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.jobs().getRecordById(7) //return jqXHR
                

HTTP/1.1 200 OK
{
    "id": 2926,
    "name": "My campaign 2016. 05. 13. 16:39:25",
    "progressCurrent": 0,
    "progressMax": 2,
    "started":
    {
        "date": "2016-05-18 14:46:13",
        "timezone_type": 3,
        "timezone": "Europe\/Budapest"
    },
    "finished": null,
    "status": "CONTACT_LIMIT_REACHED",
    "visibleUntil": null,
    "type": "CAMPAIGN_SEND",
    "referenceId": 706,
    "parent": null,
    "isStoppable": true,
    "isPausable": true,
    "children": [],
    "_links":
    {
        "self":
        {
            "href": "https:\/\/api.automizy.com\/jobs\/2926"
        }
    }
}
                

$ curl 'https://api.automizy.com/webhooks' \
-X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
    "type": "UNSUBSCRIBE",
    "url": "https://automizy.com",
 }'
                

$.ajax({
    type: "POST",
    url: "https://api.automizy.com/webhooks",
    data:{
        "type": "UNSUBSCRIBE",
        "url": "https://automizy.com",
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.webhooks().insert({
    "type": "UNSUBSCRIBE",
    "url": "https://automizy.com",
 })
                

HTTP/1.1 200 OK
{
    id: "1",
    type: "UNSUBSCRIBE",
    url: "https://automizy.com/",
    _links:{
		self:{
			href: "https:\/\/api.automizy.com\/webhooks\/1"
		}
	}

}
                

#Filtering the collection where url contains the word 'automizy':
$ curl 'https://api.automizy.com/contacts?where%5B0%5D%5B0%5D%5B0%5D=url&where%5B0%5D%5B0%5D%5B0%5D=like&where%5B0%5D%5B0%5D%5B0%5D=%automizy%' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/webhooks",
    data:{
        where:[
            [
                ['url', 'like', '%automizy%']
            ]
        ]
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.webhooks().where([
    [
        ["url", "like", "%automizy%"]
    ]
]).get() //returns jqXHR
                

HTTP/1.1 200 OK
{
	"_links":
	{
		"self":
		{
			"href": "https:\/\/api.automizy.com\/webhooks?page=1"
		},
		"first":
		{
			"href": "https:\/\/api.automizy.com\/webhooks"
		},
		"last":
		{
			"href": "https:\/\/api.automizy.com\/webhooks?page=1"
		}
	},
	"_embedded":
	{
		"webhooks": [
		{
			"id": "1",
			"type": "UNSUBSCRIBE",
			"url": "https://automizy.com/",
			"_links":
			{
				"self":
				{
					"href": "https:\/\/api.automizy.com\/webhooks\/1"
				}
			}
		}]
	},
	"page_count": 1,
	"page_size": 9223372036854775807,
	"total_items": 1,
	"page": 1
}
                

$ curl 'https://api.automizy.com/webhooks/1' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/webhooks/1",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.webhooks().getRecordById(1) //returns jqXHR
                

HTTP/1.1 200 OK
{
    id: "1",
    type: "UNSUBSCRIBE",
    url: "https://automizy.com/",
    _links:{
		self:{
			href: "https:\/\/api.automizy.com\/webhooks\/1"
		}
	}

}
                

$ curl 'https://api.automizy.com/webhooks/5' \
-X DELETE \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "DELETE",
    url: "https://api.automizy.com/webhooks/5",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section
                

$AA.contacts().webhooks.delete(5) //returns jqXHR
                

 $ curl 'https://api.automizy.com/webhooks/1' \
-X PATCH \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>' \
-d '
 {
    "url": "https://api.automizy.com/"
 }'
                

$.ajax({
    type: "PATCH",
    url: "https://api.automizy.com/webhooks/1",
    data:{
        "url": "https://api.automizy.com/"
    },
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.webhooks().update({
    "url": "https://api.automizy.com/"
}, 1) //returns jqXHR
                

HTTP/1.1 200 OK
{
    id: "1",
    type: "UNSUBSCRIBE",
    "url": "https://api.automizy.com/",
    _links:{
		self:{
			href: "https:\/\/api.automizy.com\/webhooks\/1"
		}
	}

}
                

$ curl 'https://api.automizy.com/account' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/account",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

$AA.account().get()
                

HTTP/1.1 200 OK
{
    {
	"id": 14,
	"company": "John Ltd.",
	"isFree": false,
	"hash": "14AUSSAAQSSZMD3T6O0IBOIZS",
	"type": "MONTHLY.AUTOMIZY",
	"isScriptInserted": true,
	"defaults":
	{
		"senderName": "John Doe",
		"senderEmail": "john.doe@gmail.com",
		"replyEmail": "john.doe@gmail.com",
		"emailFooter": null,
		"unsubscribeHtml": null,
		"bounceAddress": null,
		"softBounceThreshold": 5,
		"unsubscribeNotificationEmail": null
	},
	"settings":
	{
		"emails":
		{
			"unsubscribeLinkRequired": true,
			"bounceAddressConfigurable": true,
			"attachmentsEnabled": true,
			"canEmbedImagesIntoEmail": true
		},
		"customFields":
		{
			"textFieldEnabled": true
		},
		"imports":
		{
			"canImportNewContacts": true
		},
		"segments":
		{
			"canLimitSegmentsSize": true
		}
	}
}
}
                

$ curl 'https://api.automizy.com/custom-html/unsubscribe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/custom-html/unsubscribe",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

//No Automizy JS Api function for this yet
                

HTTP/1.1 200 OK
{
    html: "<!DOCTYPE html>↵<html>↵<head>↵<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />↵</head>↵<body>↵<p>You have been successfully unsubscribed</p>↵</body>↵</html>"
}
                

$ curl 'https://api.automizy.com/contact-imports' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <ACCESS TOKEN>'
                

$.ajax({
    type: "GET",
    url: "https://api.automizy.com/contact-imports",
    headers: {Authorization: 'Bearer ' + window.accessToken},
    success: function (data){
        console.log(data)
    }
 });
//What is the window.accessToken? You can see it in the Authentication section.
                

//No Automizy JS Api function for this yet
                

HTTP/1.1 200 OK
{
	"_links":
	{
		"self":
		{
			"href": "https:\/\/api.automizy.com\/contact-imports?page=1"
		},
		"first":
		{
			"href": "https:\/\/api.automizy.com\/contact-imports"
		},
		"last":
		{
			"href": "https:\/\/api.automizy.com\/contact-imports?page=1"
		}
	},
	"_embedded":
	{
		"contactImports": [
		{
			"id": "1",
			"name": "Import 2015-04-30 17:15:37",
			"date":
			{
				"date": "2015-04-30 17:15:37",
				"timezone_type": 3,
				"timezone": "Europe\/Budapest"
			},
			"importedSubscriberCount": 10000,
			"alreadyInDatabaseErrorCount": 0,
			"unSubscribedErrorCount": 0,
			"invalidEmailAddressErrorCount": 1,
			"creationForbiddenErrorCount":
			{},
			"bannedContactErrorCount": 0,
			"_links":
			{
				"self":
				{
					"href": "https:\/\/api.automizy.com\/contact-imports\/1"
				}
			}
		}]
	},
	"page_count": 1,
	"page_size": 9223372036854775807,
	"total_items": 1,
	"page": 1
}