Create Campaign
curl --request POST \
--url https://api.aimtell.com/prod/campaigns/ \
--header 'Content-Type: application/json' \
--header 'X-Authorization-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"idSite": "<string>",
"title": "<string>",
"body": "<string>",
"link": "<string>",
"schedule_date": "2023-12-25",
"segments": "<string>",
"automation": "<string>",
"push_ttl": 123,
"collapse_key": "<string>",
"auto_hide": 123,
"tz_delivery": 123,
"status": "1",
"customIcon": "<string>",
"customImage": "<string>",
"conversion_trigger": {
"eventCategory": "<string>",
"eventAction": "<string>"
},
"actions": {
"a01": {
"title": "<string>",
"link": "<string>"
},
"a02": {
"title": "<string>",
"link": "<string>"
}
}
}
'import requests
url = "https://api.aimtell.com/prod/campaigns/"
payload = {
"name": "<string>",
"idSite": "<string>",
"title": "<string>",
"body": "<string>",
"link": "<string>",
"schedule_date": "2023-12-25",
"segments": "<string>",
"automation": "<string>",
"push_ttl": 123,
"collapse_key": "<string>",
"auto_hide": 123,
"tz_delivery": 123,
"status": "1",
"customIcon": "<string>",
"customImage": "<string>",
"conversion_trigger": {
"eventCategory": "<string>",
"eventAction": "<string>"
},
"actions": {
"a01": {
"title": "<string>",
"link": "<string>"
},
"a02": {
"title": "<string>",
"link": "<string>"
}
}
}
headers = {
"X-Authorization-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Authorization-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
idSite: '<string>',
title: '<string>',
body: JSON.stringify('<string>'),
link: '<string>',
schedule_date: '2023-12-25',
segments: '<string>',
automation: '<string>',
push_ttl: 123,
collapse_key: '<string>',
auto_hide: 123,
tz_delivery: 123,
status: '1',
customIcon: '<string>',
customImage: '<string>',
conversion_trigger: {eventCategory: '<string>', eventAction: '<string>'},
actions: {
a01: {title: '<string>', link: '<string>'},
a02: {title: '<string>', link: '<string>'}
}
})
};
fetch('https://api.aimtell.com/prod/campaigns/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aimtell.com/prod/campaigns/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'idSite' => '<string>',
'title' => '<string>',
'body' => '<string>',
'link' => '<string>',
'schedule_date' => '2023-12-25',
'segments' => '<string>',
'automation' => '<string>',
'push_ttl' => 123,
'collapse_key' => '<string>',
'auto_hide' => 123,
'tz_delivery' => 123,
'status' => '1',
'customIcon' => '<string>',
'customImage' => '<string>',
'conversion_trigger' => [
'eventCategory' => '<string>',
'eventAction' => '<string>'
],
'actions' => [
'a01' => [
'title' => '<string>',
'link' => '<string>'
],
'a02' => [
'title' => '<string>',
'link' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Authorization-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aimtell.com/prod/campaigns/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"idSite\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"push_ttl\": 123,\n \"collapse_key\": \"<string>\",\n \"auto_hide\": 123,\n \"tz_delivery\": 123,\n \"status\": \"1\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"conversion_trigger\": {\n \"eventCategory\": \"<string>\",\n \"eventAction\": \"<string>\"\n },\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Authorization-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aimtell.com/prod/campaigns/")
.header("X-Authorization-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"idSite\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"push_ttl\": 123,\n \"collapse_key\": \"<string>\",\n \"auto_hide\": 123,\n \"tz_delivery\": 123,\n \"status\": \"1\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"conversion_trigger\": {\n \"eventCategory\": \"<string>\",\n \"eventAction\": \"<string>\"\n },\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aimtell.com/prod/campaigns/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Authorization-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"idSite\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"push_ttl\": 123,\n \"collapse_key\": \"<string>\",\n \"auto_hide\": 123,\n \"tz_delivery\": 123,\n \"status\": \"1\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"conversion_trigger\": {\n \"eventCategory\": \"<string>\",\n \"eventAction\": \"<string>\"\n },\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"result": "success",
"campaignId": 72129
}{
"result": "error",
"message": "Error #139."
}Manual Campaigns
Create Campaign
Create a Campaign
POST
/
prod
/
campaigns
/
Create Campaign
curl --request POST \
--url https://api.aimtell.com/prod/campaigns/ \
--header 'Content-Type: application/json' \
--header 'X-Authorization-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"idSite": "<string>",
"title": "<string>",
"body": "<string>",
"link": "<string>",
"schedule_date": "2023-12-25",
"segments": "<string>",
"automation": "<string>",
"push_ttl": 123,
"collapse_key": "<string>",
"auto_hide": 123,
"tz_delivery": 123,
"status": "1",
"customIcon": "<string>",
"customImage": "<string>",
"conversion_trigger": {
"eventCategory": "<string>",
"eventAction": "<string>"
},
"actions": {
"a01": {
"title": "<string>",
"link": "<string>"
},
"a02": {
"title": "<string>",
"link": "<string>"
}
}
}
'import requests
url = "https://api.aimtell.com/prod/campaigns/"
payload = {
"name": "<string>",
"idSite": "<string>",
"title": "<string>",
"body": "<string>",
"link": "<string>",
"schedule_date": "2023-12-25",
"segments": "<string>",
"automation": "<string>",
"push_ttl": 123,
"collapse_key": "<string>",
"auto_hide": 123,
"tz_delivery": 123,
"status": "1",
"customIcon": "<string>",
"customImage": "<string>",
"conversion_trigger": {
"eventCategory": "<string>",
"eventAction": "<string>"
},
"actions": {
"a01": {
"title": "<string>",
"link": "<string>"
},
"a02": {
"title": "<string>",
"link": "<string>"
}
}
}
headers = {
"X-Authorization-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Authorization-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
idSite: '<string>',
title: '<string>',
body: JSON.stringify('<string>'),
link: '<string>',
schedule_date: '2023-12-25',
segments: '<string>',
automation: '<string>',
push_ttl: 123,
collapse_key: '<string>',
auto_hide: 123,
tz_delivery: 123,
status: '1',
customIcon: '<string>',
customImage: '<string>',
conversion_trigger: {eventCategory: '<string>', eventAction: '<string>'},
actions: {
a01: {title: '<string>', link: '<string>'},
a02: {title: '<string>', link: '<string>'}
}
})
};
fetch('https://api.aimtell.com/prod/campaigns/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aimtell.com/prod/campaigns/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'idSite' => '<string>',
'title' => '<string>',
'body' => '<string>',
'link' => '<string>',
'schedule_date' => '2023-12-25',
'segments' => '<string>',
'automation' => '<string>',
'push_ttl' => 123,
'collapse_key' => '<string>',
'auto_hide' => 123,
'tz_delivery' => 123,
'status' => '1',
'customIcon' => '<string>',
'customImage' => '<string>',
'conversion_trigger' => [
'eventCategory' => '<string>',
'eventAction' => '<string>'
],
'actions' => [
'a01' => [
'title' => '<string>',
'link' => '<string>'
],
'a02' => [
'title' => '<string>',
'link' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Authorization-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aimtell.com/prod/campaigns/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"idSite\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"push_ttl\": 123,\n \"collapse_key\": \"<string>\",\n \"auto_hide\": 123,\n \"tz_delivery\": 123,\n \"status\": \"1\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"conversion_trigger\": {\n \"eventCategory\": \"<string>\",\n \"eventAction\": \"<string>\"\n },\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Authorization-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aimtell.com/prod/campaigns/")
.header("X-Authorization-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"idSite\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"push_ttl\": 123,\n \"collapse_key\": \"<string>\",\n \"auto_hide\": 123,\n \"tz_delivery\": 123,\n \"status\": \"1\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"conversion_trigger\": {\n \"eventCategory\": \"<string>\",\n \"eventAction\": \"<string>\"\n },\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aimtell.com/prod/campaigns/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Authorization-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"idSite\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"push_ttl\": 123,\n \"collapse_key\": \"<string>\",\n \"auto_hide\": 123,\n \"tz_delivery\": 123,\n \"status\": \"1\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"conversion_trigger\": {\n \"eventCategory\": \"<string>\",\n \"eventAction\": \"<string>\"\n },\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"result": "success",
"campaignId": 72129
}{
"result": "error",
"message": "Error #139."
}Authorizations
Body
application/json
Campaign Name
Site ID
Push Title
Push Body
Link
DateTime (e.g. 2017-08-25 21:16:50)
Segments
Automation (d = daily, w = weekly, m = monthly, n = none)
expiration time (in seconds)
replace visible notifications on a subscribers device (e.g. breaking_news)
Auto Hide (in seconds)
deliver based on user's timezone (set 0 for false, 1 for true)
1 = draft, 2 = scheduled
url of custom icon to use (recommended size: 250x250)
url of custom image to use (recommended size: 300x500)
Show child attributes
Show child attributes
action buttons
Show child attributes
Show child attributes
Response
200
⌘I

