NAV
shell ruby python javascript php

MailatMars Manage API

Give Ability to Build app With MailatMars Marketing plateform. we introduced easy to use API method that you can use in your next level development. we also provide auth 2.0 authentication for getting more partner and they make theire and our app more powerfull.

using this API platefrom you can use wide range of feature that also use from your user intereface.

All request Send By Access Token That You getting from MailatMars console.

for get Access Token Please Go to dev.mailatmars.com

Manage List

Get All List


import requests


url = "https://api.mailatmars.com/list"


payload = {}
headers = {
'Authorization': 'Bearer jlg9geg848jkak9gn9bj18ki'
}


response = requests.request("GET", url, headers=headers, data = payload)


print(response.text.encode('utf8'))



require "uri"
require "net/http"



url = URI("https://api.mailatmars.com/list")



http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer jlg9geg848jkak9gn9bj18ki"



response = http.request(request)
puts response.read_body




var settings = {
  "url": "https://api.mailatmars.com/list",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer jlg9geg848jkak9gn9bj18ki"
  },
};



$.ajax(settings).done(function (response) {
  console.log(response);
});




curl --location --request GET 'https://api.mailatmars.com/list' </span>
--header 'Authorization: Bearer jlg9geg848jkak9gn9bj18ki'




<?php



$curl = curl_init();



curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer jlg9geg848jkak9gn9bj18ki"
  ),
));



$response = curl_exec($curl);



curl_close($curl);
echo $response;

Response

[
    {
        "id": "497889959^dXNlcl90cmlhbA==",
        "name": "user_trial",
        "contact_count": 8
    }
]

This Endpoint Use for getting all Contact List That present in mailatmars account.

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

No Parameter Available

Response Field

Field Explain
id id of your Contact List it is important for API Use
name name of yur contact list important at console
contact_count Count Of Present contact in list

Create List

import requests



url = "https://api.mailatmars.com/list/create?list_name=ravi_n"



payload = {}
headers = {
  'Authorization': 'Bearer jlg9geg848jkak9gn9bj18ki'
}



response = requests.request("POST", url, headers=headers, data = payload)



print(response.text.encode('utf8'))




require "uri"
require "net/http"



url = URI("https://api.mailatmars.com/list/create?list_name=ravi_n")



http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer jlg9geg848jkak9gn9bj18ki"



response = http.request(request)
puts response.read_body




var settings = {
  "url": "https://api.mailatmars.com/list/create?list_name=ravi_n",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer jlg9geg848jkak9gn9bj18ki"
  },
};



$.ajax(settings).done(function (response) {
  console.log(response);
});



curl --location --request POST 'https://api.mailatmars.com/list/create?list_name=ravi_n' </span>
--header 'Authorization: Bearer jlg9geg848jkak9gn9bj18ki'




<?php



$curl = curl_init();



curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/create?list_name=ravi_n",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer jlg9geg848jkak9gn9bj18ki"
  ),
));



$response = curl_exec($curl);



curl_close($curl);
echo $response;

Response


{
    "status": 1,
    "message": "497889959^cmF2aV94"
}

This Endpoint Use for Creating new list at mailatmars account.

Request Information

Category Value
Request Type POST
URL https://api.mailatmars.com/list/create

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_name Name Of List Unique Name Required

Response Field

Field Explain
Status Status Of Request 1 for success full
message status is 1 then message is list_id or message is error

List Schemas

import requests



url = "https://api.mailatmars.com/list/497889959^cF2aV9u/fields"



payload = {}
headers = {
  'Authorization': 'Bearer jlg9geg848jkak9gn9bj18ki'
}



response = requests.request("GET", url, headers=headers, data = payload)



print(response.text.encode('utf8'))



require "uri"
require "net/http"



url = URI("https://api.mailatmars.com/list/497889959^cF2aV9u/fields")



http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer jlg9geg848jkak9gn9bj18ki"



response = http.request(request)
puts response.read_body



var settings = {
  "url": "https://api.mailatmars.com/list/497889959^cF2aV9u/fields",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer jlg9geg848jkak9gn9bj18ki"
  },
};



$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/497889959^cF2aV9u/fields' </span>
--header 'Authorization: Bearer jlg9geg848jkak9gn9bj18ki'

<?php



$curl = curl_init();



curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/497889959%5EcF2aV9u/fields",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer jlg9geg848jkak9gn9bj18ki"
  ),
));



$response = curl_exec($curl);



curl_close($curl);
echo $response;

Response successfull


[
    {
        "name": "email",
        "type": "varchar"
    },
    {
        "name": "firstname",
        "type": "varchar"
    },
    {
        "name": "lastname",
        "type": "varchar"
    },
    {
        "name": "address",
        "type": "varchar"
    },
    {
        "name": "phone",
        "type": "bigint"
    },
    {
        "name": "birthdate",
        "type": "date"
    }
]

Response Error

{
    "status": 0,
    "message": "List Or Fields Not Found"
}

This Endpoint is usefull for getting schema of contact list easily throught API request

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:list_id/fields

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_name list id of list How To get List Id

Response SuccessFull

get every field of list two parameter as define below

Field Explain
name Name Of fields
type data typeof field as mysql data type

Response Error

Field Explain
status status is 0 if error accurs
message if list is not present or any field is not present than error accurs

Delete List

import requests

url = "https://api.mailatmars.com/list/497889959^cmF2aV9u/delete"

payload = {}
headers = {
  'Authorization': 'Bearer jlg9geg848jkak9gn9bj18ki'
}

response = requests.request("DELETE", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/497889959^cmF2aV9u/delete")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Delete.new(url)
request["Authorization"] = "Bearer jlg9geg848jkak9gn9bj18ki"

response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/list/497889959^cmF2aV9u/delete",
  "method": "DELETE",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer jlg9geg848jkak9gn9bj18ki"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request DELETE 'https://api.mailatmars.com/list/497889959^cmF2aV9u/delete' \
--header 'Authorization: Bearer jlg9geg848jkak9gn9bj18ki'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/497889959%5EcmF2aV9u/delete",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer jlg9geg848jkak9gn9bj18ki"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

{
    "status": 1,
    "message": "List deleted"
}

Response Error

{
    "status": 0,
    "message": "Something Wen't Wrong"
}

This Endpoint is usefull for Delete list of contact. remind that if you delete list then all contact and contact response analysis also deleted.

Request Information

Category Value
Request Type DELETE
URL https://api.mailatmars.com/list/:list_id/delete

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id

Response SuccessFull

Field Explain
status 1 if successfull list deleted
message List Deleted

Response Error

Field Explain
status status is 0 if error accurs
message Message Of Error

List Analysis

This Endpoint Use for getting data of list analysis. this endpoint is give complex response of analysis so be carefull to interpret.successfull

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/data/analysis"

payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/data/analysis")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"

response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/data/analysis",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/data/analysis' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/data/analysis",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

{
"month":{"click":[0,0,0,0,0,0,0,0,2,0,0,0],"open":[0,0,0,0,0,0,0,0,5,0,0,0]},
"day":{"click":[0,2,0,0,0,0,0],"open":[0,5,0,0,0,0,0]},
"hr":{"click":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,0,0,0,0,0],"open":[0,0,0,0,0,0,0,0,0,0,0,1,2,0,0,0,0,0,1,0,1,0,0,0]},
"count":{"click_count":2,"open_count":5}
}

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:list_id/data/analysis

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id

Response SuccessFull

Field Explain
Count Count Of Email data
Month Array length is 12 (January to December)
Day Array length is 7 (Sunday to Saturaday)
Hour Array length is 24 (1 to 24)
Open Open count of email
Click Click count of email

Contact Of List

This Endpoint Use for getting data of list contact. it give whole data about list contact that you can not easily shown on console.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/all"

payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))


require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/all")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"

response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/all",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/all' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/all",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

[
    {
        "email": "ravigorasiya65@gmail.com",
        "firstname": "",
        "lastname": "",
        "address": "",
        "phone": "0",
        "birthdate": "0000-00-00",
        "tag": "11,",
        "substatus": 1,
        "source": "admin",
        "segment": "",
        "arch": 1,
        "crt_date": "2021-09-26T18:30:00.000Z",
        "chg_date": "2021-09-26T18:30:00.000Z",
        "con_id": 1,
        "gender_pre": "m",
        "age_pre": "30",
        "usr_star": 0,
        "458642694^1632699052": 2,
        "458642694^1632701077": 2
    }
]

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:list_id/all

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id

Response SuccessFull

Field Explain
email Email address of contact
Tag show tag id by , split
substatus Define subscribe status of contact how is it recognize
Source Source of contact
arch archive status of contact if 0 then contact archived and 1 for contact unarchived
crt_date Date of contact creation
chg_date update contact date
con_id unique id of contact in list
gender_pre Predicted gender of contact by mailatmars
age_pre predicted age of contact by mailatmars
usr_star user star of contact
458642694^1632699052 campign on this contact show more
other other field is as per admin choice

Manage Contact

Get Contact

endpoint use for get contact detail from list.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/email/ravigorasiya65@gmail.com"

payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/email/ravigorasiya65@gmail.com")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"

response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/email/ravigorasiya65@gmail.com",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/email/ravigorasiya65@gmail.com' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/email/ravigorasiya65@gmail.com",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

[
    {
        "email": "ravigorasiya65@gmail.com",
        "firstname": "",
        "lastname": "",
        "address": "",
        "phone": "0",
        "birthdate": "0000-00-00",
        "tag": "11,",
        "substatus": 1,
        "source": "admin",
        "segment": "",
        "arch": 1,
        "crt_date": "2021-09-26T18:30:00.000Z",
        "chg_date": "2021-09-26T18:30:00.000Z",
        "con_id": 1,
        "gender_pre": "m",
        "age_pre": "30",
        "usr_star": 0,
        "458642694^1632699052": 2,
        "458642694^1632701077": 2
    }
]

This Endpoint is usefull for Delete list of contact. remind that if you delete list then all contact and contact response analysis also deleted.

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:list_id/email/:email_add

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
email_add saved email of contact in list

Response SuccessFull

Field Explain
email Email address of contact
Tag show tag id by , split
substatus Define subscribe status of contact how is it recognize
Source Source of contact
arch archive status of contact if 0 then contact archived and 1 for contact unarchived
crt_date Date of contact creation
chg_date update contact date
con_id unique id of contact in list
gender_pre Predicted gender of contact by Auftera
age_pre predicted age of contact by Auftera
usr_star user star of contact
458642694^1632699052 campign on this contact show more
other other field is as per admin choice

Add Contact

endpoint is use for create new contact in contact list. with adding custome sources.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/add/?tag=11&substatus=subscribe"

payload = "{'email':'test-2cdb@gnc.com'}"
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/add/?tag=11&substatus=subscribe")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"
request["Content-Type"] = "application/json"
request.body = "{'email':'test-2cdb@gnc.com'}"

response = http.request(request)
puts response.read_body



var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/add/?tag=11&substatus=subscribe",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a",
    "Content-Type": "application/json"
  },
  "data": "{'email':'test-2cdb@gnc.com'}",
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request POST 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/add/?tag=11&substatus=subscribe' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a' \
--header 'Content-Type: application/json' \
--data-raw '{'\''email'\'':'\''test-2cdb@gnc.com'\''}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/add/?tag=11&substatus=subscribe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{'email':'test-2cdb@gnc.com'}",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

{
    "status": 1,
    "data_cnt": 10
}

Response Error


{
    "status": 0,
    "error_code": "stat_define",
    "message": "Enter valid Status of contact in substatus Field",
    "help_link": ""
}

Body Content


{
"email":"test-54cdb@gnc.com",
"firstname":"test"
}

Request Information

Category Value
Request Type POST
URL https://api.mailatmars.com/list/:list_id/add/

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
tag_id id of tag how to get tag id

Query Parameter

Key Value Information
tag tag value with tag_id and seprated by , get tag id and seprate with ,
substatus subscribe status of contact subscribe status of contact type of status

Body Content

This endpoint needed JSON body content. you can add content field wise.help_link you can see json schema in right side display

Response SuccessFull

Field Explain
status 1 status if successfull contact created
data_cnt count of all contact

Response Failure

field Explain
status 0 if failed request
error_code error code when error accure
message message of error
help_link link of help

Contact By Tag

Endpoint use to get contact tag wise. simply enter tag and get contact tag wise from list.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/tag/11"

payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/tag/11")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"

response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/tag/11",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/tag/11' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/tag/11",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

[
    {
        "email": "ravigorasiya65@gmail.com",
        "firstname": "",
        "lastname": "",
        "address": "",
        "phone": "0",
        "birthdate": "0000-00-00",
        "tag": "11,",
        "substatus": 1,
        "source": "admin",
        "segment": "",
        "arch": 1,
        "crt_date": "2021-09-26T18:30:00.000Z",
        "chg_date": "2021-09-26T18:30:00.000Z",
        "con_id": 1,
        "gender_pre": "m",
        "age_pre": "30",
        "usr_star": 0,
        "458642694^1632699052": 2,
        "458642694^1632701077": 2
    }
]

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:list_id/tag/:tag_id

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
tag_id id of tag how to get tag id

Response SuccessFull

Field Explain
email Email address of contact
Tag show tag id by , split
substatus Define subscribe status of contact how is it recognize
Source Source of contact
arch archive status of contact if 0 then contact archived and 1 for contact unarchived
crt_date Date of contact creation
chg_date update contact date
con_id unique id of contact in list
gender_pre Predicted gender of contact by Auftera
age_pre predicted age of contact by Auftera
usr_star user star of contact
458642694^1632699052 campign on this contact show more
other other field is as per admin choice

Contact By Field

you can search contact by field that you select customally from console.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/firstname/rahul"

payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))


require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/firstname/rahul")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"

response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/firstname/rahul",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/firstname/rahul' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/firstname/rahul",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

[
    {
        "email": "rahulrameshgorasiya@gmail.com",
        "firstname": "Rahul",
        "lastname": "",
        "address": "",
        "phone": "0",
        "birthdate": "0000-00-00",
        "tag": "11,",
        "substatus": 1,
        "source": "admin",
        "segment": "",
        "arch": 0,
        "crt_date": "2021-09-26T18:30:00.000Z",
        "chg_date": "2021-09-26T18:30:00.000Z",
        "con_id": 2,
        "gender_pre": "m",
        "age_pre": "39",
        "usr_star": 0,
        "458642694^1632699052": 0,
        "458642694^1632701077": 10
    }
]

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:list_id/:field_name/:match_data

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
field_name field name in list how to get tag id
match_data data that you find in list by different value in according to this

Response SuccessFull

Field Explain
email Email address of contact
Tag show tag id by , split
substatus Define subscribe status of contact how is it recognize
Source Source of contact
arch archive status of contact if 0 then contact archived and 1 for contact unarchived
crt_date Date of contact creation
chg_date update contact date
con_id unique id of contact in list
gender_pre Predicted gender of contact by Auftera
age_pre predicted age of contact by Auftera
usr_star user star of contact
458642694^1632699052 campign on this contact show more
other other field is as per admin choice

Contact By Status

get contact by status using this endpoint.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/status/subscribe"

payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))


require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/status/subscribe")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"

response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/status/subscribe",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/status/subscribe' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/status/subscribe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

[
    {
        "email": "rahulrameshgorasiya@gmail.com",
        "firstname": "Rahul",
        "lastname": "",
        "address": "",
        "phone": "0",
        "birthdate": "0000-00-00",
        "tag": "11,",
        "substatus": 1,
        "source": "admin",
        "segment": "",
        "arch": 0,
        "crt_date": "2021-09-26T18:30:00.000Z",
        "chg_date": "2021-09-26T18:30:00.000Z",
        "con_id": 2,
        "gender_pre": "m",
        "age_pre": "39",
        "usr_star": 0,
        "458642694^1632699052": 0,
        "458642694^1632701077": 10
    }
]

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:list_id/status/:status_of_search

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
status_of_search Status name that you search in contact

Response SuccessFull

Field Explain
email Email address of contact
Tag show tag id by , split
substatus Define subscribe status of contact how is it recognize
Source Source of contact
arch archive status of contact if 0 then contact archived and 1 for contact unarchived
crt_date Date of contact creation
chg_date update contact date
con_id unique id of contact in list
gender_pre Predicted gender of contact by Auftera
age_pre predicted age of contact by Auftera
usr_star user star of contact
458642694^1632699052 campign on this contact show more
other other field is as per admin choice

Contact By Source

get contact by source using this endpoint.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/source/admin"

payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/source/admin")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"

response = http.request(request)
puts response.read_body



var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/source/admin",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/source/admin' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/source/admin",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

[
    {
        "email": "rahulrameshgorasiya@gmail.com",
        "firstname": "Rahul",
        "lastname": "",
        "address": "",
        "phone": "0",
        "birthdate": "0000-00-00",
        "tag": "11,",
        "substatus": 1,
        "source": "admin",
        "segment": "",
        "arch": 0,
        "crt_date": "2021-09-26T18:30:00.000Z",
        "chg_date": "2021-09-26T18:30:00.000Z",
        "con_id": 2,
        "gender_pre": "m",
        "age_pre": "39",
        "usr_star": 0,
        "458642694^1632699052": 0,
        "458642694^1632701077": 10
    }
]

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:list_id/source/:source_name

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
source_name source name of contact

Response SuccessFull

Field Explain
email Email address of contact
Tag show tag id by , split
substatus Define subscribe status of contact how is it recognize
Source Source of contact
arch archive status of contact if 0 then contact archived and 1 for contact unarchived
crt_date Date of contact creation
chg_date update contact date
con_id unique id of contact in list
gender_pre Predicted gender of contact by Auftera
age_pre predicted age of contact by Auftera
usr_star user star of contact
458642694^1632699052 campign on this contact show more
other other field is as per admin choice

Update Contact Field

Update contact field that you created in field section of list on console.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/tag/13"

payload = "{\"email\":\"test-54cdb@gnc.com\"}"
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/tag/13")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"
request["Content-Type"] = "application/json"
request.body = "{\"email\":\"test-54cdb@gnc.com\"}"

response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/tag/13",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a",
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({"email":"test-54cdb@gnc.com"}),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request POST 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/tag/13' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a' \
--header 'Content-Type: application/json' \
--data-raw '{"email":"test-54cdb@gnc.com"}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/ravigorasiya65@gmail.com/set/tag/13",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{\"email\":\"test-54cdb@gnc.com\"}",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

{
    "status": 1,
    "message": "change tagsuccessfully"
}

Request Information

Category Value
Request Type POST
URL https://api.mailatmars.com/list/:lst_id/:email/set/:field_name/:data_up

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
email email that you can edit field
field_name name of field in contact list
data updated data of particular field

Response SuccessFull

Field Explain
status 1 if request edit successfull
message change :field successfull

Update Contact Status

Update contact subscribe status in contact list.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/substatus/un-subscribe"

payload = "{\n    \"email\": \"test-54cdb@gnc.com\"\n}"
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/substatus/un-subscribe")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"
request["Content-Type"] = "application/json"
request.body = "{\n    \"email\": \"test-54cdb@gnc.com\"\n}"

response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/substatus/un-subscribe",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a",
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({"email":"test-54cdb@gnc.com"}),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request POST 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/substatus/un-subscribe' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "test-54cdb@gnc.com"
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/ravigorasiya65@gmail.com/set/substatus/un-subscribe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{\n    \"email\": \"test-54cdb@gnc.com\"\n}",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

{
    "status": 1,
    "message": "change substatus successfully"
}

Request Information

Category Value
Request Type POST
URL https://api.mailatmars.com/list/:lst_id/:email/set/substatus/:data_up

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
email email that you can edit field
data_up updated data of particular field

Response SuccessFull

Field Explain
status 1 if request edit successfull
message change substatus successfull

Update Contact Tag

Using this endpoint you can update contact tag in contact list.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/tag/11"

payload = "{\n    \"email\": \"test-54cdb@gnc.com\"\n}"
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/tag/11")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"
request["Content-Type"] = "application/json"
request.body = "{\n    \"email\": \"test-54cdb@gnc.com\"\n}"

response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/tag/11",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a",
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({"email":"test-54cdb@gnc.com"}),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request POST 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/set/tag/11' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "test-54cdb@gnc.com"
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/ravigorasiya65@gmail.com/set/tag/11",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{\n    \"email\": \"test-54cdb@gnc.com\"\n}",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

{
    "status": 1,
    "message": "change tag successfully"
}

Request Information

Category Value
Request Type POST
URL https://api.mailatmars.com/list/:lst_id/:email/set/tag/:data_up

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
email email that you can edit field
data_up updated data of particular field

Response SuccessFull

Field Explain
status 1 if request edit successfull
message change tag successfull

Get contact Tag

using this endpoint you can get any field of contact in specific list.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/tag"

payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))




require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/tag")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"

response = http.request(request)
puts response.read_body



var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/tag",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/tag' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/ravigorasiya65@gmail.com/info/tag",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

{
    "tag": "11,"
}

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:lst_id/:email/info/tag/

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
email email that you can edit field

Response SuccessFull

Field Explain
:field_name all tag id you can get after seperated by ,

Get contact status

using this endpoint you can get subscribe status of any contact in specific list.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/substatus"

payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/substatus")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"

response = http.request(request)
puts response.read_body



var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/substatus",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/substatus' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/ravigorasiya65@gmail.com/info/substatus",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

{
    "substatus": "0"
}

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:lst_id/:email/info/substatus/

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
email email that you can edit field

Response SuccessFull

Field Explain
substatus subscribe status of contact. how to recignize it

Get Contact Source

using this endpoint you can get source of any contact in specific list.

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/source"

payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/source")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"

response = http.request(request)
puts response.read_body



var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/source",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/ravigorasiya65@gmail.com/info/source' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/ravigorasiya65@gmail.com/info/source",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

{
    "source": "admin"
}

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:lst_id/:email/info/source/

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
email email that you can edit field

Response SuccessFull

Field Explain
source define source of contact

Contact Analysis report

Using this endpoint you can get performance of contact on sheduled campigns.source

import requests

url = "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/rahulrameshgorasiya@gmail.com/data/performance"

payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))



require "uri"
require "net/http"

url = URI("https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/rahulrameshgorasiya@gmail.com/data/performance")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"

response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/rahulrameshgorasiya@gmail.com/data/performance",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/list/458642694^dGVzdF9zZWc=/rahulrameshgorasiya@gmail.com/data/performance' \
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/list/458642694%5EdGVzdF9zZWc=/rahulrameshgorasiya@gmail.com/data/performance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response successfull

[
    {
        "camp_name": "vsbdgc",
        "action": [
            {
                "action": "send",
                "date_time": "2021-09-15 13:24:00"
            },
            {
                "action": "click",
                "date_time": "2021-09-27 19:21:01"
            },
            {
                "action": "click",
                "date_time": "2021-09-27 19:19:58"
            },
            {
                "action": "open",
                "date_time": "2021-09-27 19:19:52"
            },
            {
                "action": "open",
                "date_time": "2021-09-27 13:33:15"
            }
        ]
    }
]

here, show prformance if and if contact perform click and open task on email. rather than not only sended email show in performance.

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/list/:lst_id/:email/data/performance

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
list_id list id of list How To get List Id
email email address of contact from list

Response SuccessFull

Field Explain
camp_name name of email campign
action show all action on email
task task that perform on email of that campign
date_time date and time of action

Manage Campign

Get Campign

Using this endpoint you can get performance of contact on sheduled campigns.source

import requests


url = "https://api.mailatmars.com/campign/all/"


payload = {}
headers = {
'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}


response = requests.request("GET", url, headers=headers, data = payload)


print(response.text.encode('utf8'))


require "uri"
require "net/http"



url = URI("https://api.mailatmars.com/campign/all/")



http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"



response = http.request(request)
puts response.read_body



var settings = {
  "url": "https://api.mailatmars.com/campign/all/",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};



$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/campign/all/' </span>
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php



$curl = curl_init();



curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/campign/all/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));



$response = curl_exec($curl);



curl_close($curl);
echo $response;

Response successfull

[
    {
        "name": "test_seg",
        "sheduled": "2021-09-27 12:03:00",
        "send_status": "0"
    }
]

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/campign/all/

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

No URL Paremeter needed

Response SuccessFull

Field Explain
name name of email campign
sheduled sheduled time of campign
send_status sending status of campign how to identify

Delete Campign

Using this endpoint you can delete existing campign in user mailatmars account.

import requests



url = "https://api.mailatmars.com/campign/delete/bchdcd"



payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}



response = requests.request("DELETE", url, headers=headers, data = payload)



print(response.text.encode('utf8'))



require "uri"
require "net/http"



url = URI("https://api.mailatmars.com/campign/delete/bchdcd")



http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Delete.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"



response = http.request(request)
puts response.read_body



var settings = {
  "url": "https://api.mailatmars.com/campign/delete/bchdcd",
  "method": "DELETE",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};



$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request DELETE 'https://api.mailatmars.com/campign/delete/bchdcd' </span>
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php



$curl = curl_init();



curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/campign/delete/bchdcd",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));



$response = curl_exec($curl);



curl_close($curl);
echo $response;

Response successfull

{
    "status": 1,
    "message": "Campign Deleted SuccessFully"
}

Response Failure


{
    "status": 0,
    "message": "Something Went't wrong"
}

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/campign/delete/:camp_name

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
camp_name name of campign show on console How To get List Id

Response SuccessFull

Field Explain
status if successfull then 1 otherwise 0
message Message show according to request

Campign Analysis report

Using this endpoint you can get performance of campign on specified list.

import requests



url = "https://api.mailatmars.com/campign/458642694^1632540617/458642694^bmV3X3Rlc3Q=/performance"



payload = {}
headers = {
  'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}



response = requests.request("GET", url, headers=headers, data = payload)



print(response.text.encode('utf8'))



require "uri"
require "net/http"



url = URI("https://api.mailatmars.com/campign/458642694^1632540617/458642694^bmV3X3Rlc3Q=/performance")



http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"



response = http.request(request)
puts response.read_body



var settings = {
  "url": "https://api.mailatmars.com/campign/458642694^1632540617/458642694^bmV3X3Rlc3Q=/performance",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};



$.ajax(settings).done(function (response) {
  console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/campign/458642694^1632540617/458642694^bmV3X3Rlc3Q=/performance' </span>
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php



$curl = curl_init();



curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.mailatmars.com/campign/458642694%5E1632540617/458642694%5EbmV3X3Rlc3Q=/performance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer k9hf264j5ie8l1a28757c75a"
  ),
));



$response = curl_exec($curl);



curl_close($curl);
echo $response;

Response successfull

{
    "month":{
             "click":[0,0,0,0,0,0,0,0,0,0,0,0],
             "open":[0,0,0,0,0,0,0,0,2,0,0,0]
             },
    "day":{
           "click":[0,0,0,0,0,0,0],
           "open":[0,0,0,0,0,0,2]
           },
    "hr":{
          "click":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
          "open":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,0,0,0,0,0,0,0,0]
          },
    "count":{
             "click_count":0,
             "open_count":2
             }
}

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/campign/:camp_id/:lst_id/performance

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
camp_id campign id of campign how get campign id
lst_id list id of contact list required to campign send for this list also

Response SuccessFull

Field Explain
Count Count Of Email data
Month Array length is 12 (January to December)
Day Array length is 7 (Sunday to Saturaday)
Hour Array length is 24 (1 to 24)
Open Open count of email
Click Click count of email

Manage Studio

Get Folder

get all studio folder details using this endpoint.

import requests


url = "https://api.mailatmars.com/studio/all"


payload = {}
headers = {
'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}


response = requests.request("GET", url, headers=headers, data = payload)


print(response.text.encode('utf8'))


require "uri"
require "net/http"


url = URI("https://api.mailatmars.com/studio/all")


http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"


response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/studio/all",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};


$.ajax(settings).done(function (response) {
console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/studio/all' </span>
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php


$curl = curl_init();


curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.mailatmars.com/studio/all",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: Bearer k9hf264j5ie8l1a28757c75a"
),
));


$response = curl_exec($curl);


curl_close($curl);
echo $response;

Response successfull

[
    {
        "dir_name": "test_fold",
        "dir_id": "458642694^dGVzdF9mb2xk",
        "crt_date": "2021-10-03",
        "image_count": "6"
    },
    {
        "dir_name": "admin",
        "dir_id": "458642694^YWRtaW4=",
        "crt_date": "2021-09-23",
        "image_count": "16"
    }
]

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/studio/all

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

No Parmeter needed.

Response SuccessFull

Field Explain
dir_name display name of studio folder
dir_id id of studio folder
crt_date created date of studio folder
image_count count of image present in folder

Create Folder

create new folder in studio account using this endpoint

import requests


url = "https://api.mailatmars.com/studio/new/next"


payload = {}
headers = {
'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}


response = requests.request("POST", url, headers=headers, data = payload)


print(response.text.encode('utf8'))


require "uri"
require "net/http"


url = URI("https://api.mailatmars.com/studio/new/next")


http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"


response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/studio/new/next",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};


$.ajax(settings).done(function (response) {
console.log(response);
});

curl --location --request POST 'https://api.mailatmars.com/studio/new/next' </span>
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php


$curl = curl_init();


curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.mailatmars.com/studio/new/next",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => array(
"Authorization: Bearer k9hf264j5ie8l1a28757c75a"
),
));


$response = curl_exec($curl);


curl_close($curl);
echo $response;

Response successfull

{
    "status": 1,
    "message": "Create Folder SuccesFull"
}

Request Information

Category Value
Request Type POST
URL https://api.mailatmars.com/studio/new/:fold_name

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
fold_name Unique name of new folder This Is unique name

Response SuccessFull

Field Explain
status status 1 if successfull created and 0 if not created
message text or hint for next step

Upload Image

add image in your studio folder from image url using this endpoint.

import requests


url = "https://api.mailatmars.com/studio/458642694^bm93/up/url/?url=https://lumiere-a.akamaihd.net/v1/images/sa_pixar_virtualbg_coco_16x9_9ccd7110.jpeg?region=0,0,1920,1080%26width=768"


payload = {}
headers = {
'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}


response = requests.request("POST", url, headers=headers, data = payload)


print(response.text.encode('utf8'))


require "uri"
require "net/http"


url = URI("https://api.mailatmars.com/studio/458642694^bm93/up/url/?url=https://lumiere-a.akamaihd.net/v1/images/sa_pixar_virtualbg_coco_16x9_9ccd7110.jpeg?region=0,0,1920,1080%26width=768")


http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"


response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/studio/458642694^bm93/up/url/?url=https://lumiere-a.akamaihd.net/v1/images/sa_pixar_virtualbg_coco_16x9_9ccd7110.jpeg?region=0,0,1920,1080%26width=768",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};


$.ajax(settings).done(function (response) {
console.log(response);
});

curl --location --request POST 'https://api.mailatmars.com/studio/458642694^bm93/up/url/?url=https://lumiere-a.akamaihd.net/v1/images/sa_pixar_virtualbg_coco_16x9_9ccd7110.jpeg?region=0,0,1920,1080%26width=768' </span>
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php


$curl = curl_init();


curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.mailatmars.com/studio/458642694%5Ebm93/up/url/?url=https://lumiere-a.akamaihd.net/v1/images/sa_pixar_virtualbg_coco_16x9_9ccd7110.jpeg?region=0,0,1920,1080%2526width=768",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => array(
"Authorization: Bearer k9hf264j5ie8l1a28757c75a"
),
));


$response = curl_exec($curl);


curl_close($curl);
echo $response;

Response successfull

{
    "status": 1,
    "cdn_link": "https://img.auftera.com/images/458642694^bm93^1.jpeg"
}

Request Information

Category Value
Request Type GET
URL https://api.mailatmars.com/studio/:fold_id/up/url

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
fold_id id of studio folder how to get folder id

Query Parameter

key Value
url live image full url

Response SuccessFull

Field Explain
status status 1 if successfull created and 0 if not created
cdn_link cdn link of uploaded image

Rename Folder

you can rename studio folder using this endpoint.

import requests


url = "https://api.mailatmars.com/studio/458642694^YWRtaW4=/rename?fold_name=auftera3"


payload = {}
headers = {
'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}


response = requests.request("POST", url, headers=headers, data = payload)


print(response.text.encode('utf8'))


require "uri"
require "net/http"


url = URI("https://api.mailatmars.com/studio/458642694^YWRtaW4=/rename?fold_name=auftera3")


http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"


response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/studio/458642694^YWRtaW4=/rename?fold_name=auftera3",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};


$.ajax(settings).done(function (response) {
console.log(response);
});

curl --location --request POST 'https://api.mailatmars.com/studio/458642694^YWRtaW4=/rename?fold_name=auftera3' </span>
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php


$curl = curl_init();


curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.mailatmars.com/studio/458642694%5EYWRtaW4=/rename?fold_name=auftera3",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => array(
"Authorization: Bearer k9hf264j5ie8l1a28757c75a"
),
));


$response = curl_exec($curl);


curl_close($curl);
echo $response;

Response successfull

{
    "status": 1,
    "message": "Renamed Succesfully"
}

Request Information

Category Value
Request Type POST
URL https://api.mailatmars.com/studio/:fold_id/rename

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
fold_id id of studio folder how to get folder id

Query Parameter

key Value
fold_name folder name of new folder that created after renamed

Response SuccessFull

Field Explain
status status 1 if successfull created and 0 if not created
message according to your valide request

Image Of Folder

this endpoint is usefull for getting all image that are available in selected studio folder.

import requests


url = "https://api.mailatmars.com/studio/458642694^dGVzdF9pbWc=/images"


payload = {}
headers = {
'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}


response = requests.request("GET", url, headers=headers, data = payload)


print(response.text.encode('utf8'))


require "uri"
require "net/http"


url = URI("https://api.mailatmars.com/studio/458642694^dGVzdF9pbWc=/images")


http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"


response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/studio/458642694^dGVzdF9pbWc=/images",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};


$.ajax(settings).done(function (response) {
console.log(response);
});

curl --location --request GET 'https://api.mailatmars.com/studio/458642694^dGVzdF9pbWc=/images' </span>
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php


$curl = curl_init();


curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.mailatmars.com/studio/458642694%5EdGVzdF9pbWc=/images",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: Bearer k9hf264j5ie8l1a28757c75a"
),
));


$response = curl_exec($curl);


curl_close($curl);
echo $response;

Response successfull

[
    {
        "image": "458642694^dGVzdF9pbWc=^0.png",
        "width": "64",
        "height": "64",
        "size": "1358",
        "org_name": "facebook.png",
        "date_img": "2021-10-25 05:00:55"
    },
    {
        "image": "458642694^dGVzdF9pbWc=^1.png",
        "width": "64",
        "height": "64",
        "size": "1997",
        "org_name": "google.png",
        "date_img": "2021-10-25 05:00:59"
    }
]

Request Information

Category Value
Request Type POST
URL https://api.mailatmars.com/studio/:fold_id/images

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
fold_id id Of studio folder how to get folder id

Response SuccessFull

Field Explain
image server name of image
width width of image
height height of image
size size in byte of image
org_name uploaded name of image
date_img uploaded date and time of image

Delete Folder

you can rename studio folder using this endpoint.

import requests


url = "https://api.mailatmars.com/studio/delete/folder/nvhndc"


payload = {}
headers = {
'Authorization': 'Bearer k9hf264j5ie8l1a28757c75a'
}


response = requests.request("DELETE", url, headers=headers, data = payload)


print(response.text.encode('utf8'))


require "uri"
require "net/http"


url = URI("https://api.mailatmars.com/studio/delete/folder/nvhndc")


http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Delete.new(url)
request["Authorization"] = "Bearer k9hf264j5ie8l1a28757c75a"


response = http.request(request)
puts response.read_body


var settings = {
  "url": "https://api.mailatmars.com/studio/delete/folder/nvhndc",
  "method": "DELETE",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer k9hf264j5ie8l1a28757c75a"
  },
};


$.ajax(settings).done(function (response) {
console.log(response);
});

curl --location --request DELETE 'https://api.mailatmars.com/studio/delete/folder/nvhndc' </span>
--header 'Authorization: Bearer k9hf264j5ie8l1a28757c75a'

<?php


$curl = curl_init();


curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.mailatmars.com/studio/delete/folder/nvhndc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => array(
"Authorization: Bearer k9hf264j5ie8l1a28757c75a"
),
));


$response = curl_exec($curl);


curl_close($curl);
echo $response;

Response successfull

{
    "status": 1,
    "message": "SucessFully Deleted"
}

Request Information

Category Value
Request Type DELETE
URL https://api.mailatmars.com/studio/delete/folder/:fold_name

Header Information

Parameters Value
Berear Token Access Token From Console

URL Parameter

Key Value Information
fold_name name of studio folder how to get folder id

Response SuccessFull

Field Explain
status status 1 if successfull created and 0 if not created
message according to your valid request

shell ruby python javascript php