Send Push Notification
curl --request POST \
--url https://api.aimtell.com/prod/push/ \
--header 'Content-Type: application/json' \
--header 'X-Authorization-Api-Key: <api-key>' \
--data '
{
"idSite": 123,
"title": "<string>",
"body": "<string>",
"link": "<string>",
"subscriber_uids": [
"<string>"
],
"segmentId": 123,
"alias": "<string>",
"customIcon": "<string>",
"customImage": "<string>",
"push_ttl": 604800,
"auto_hide": 123,
"collapse_key": "<string>",
"actions": {
"a01": {
"title": "<string>",
"link": "<string>"
},
"a02": {
"title": "<string>",
"link": "<string>"
}
}
}
'import requests
url = "https://api.aimtell.com/prod/push/"
payload = {
"idSite": 123,
"title": "<string>",
"body": "<string>",
"link": "<string>",
"subscriber_uids": ["<string>"],
"segmentId": 123,
"alias": "<string>",
"customIcon": "<string>",
"customImage": "<string>",
"push_ttl": 604800,
"auto_hide": 123,
"collapse_key": "<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({
idSite: 123,
title: '<string>',
body: JSON.stringify('<string>'),
link: '<string>',
subscriber_uids: ['<string>'],
segmentId: 123,
alias: '<string>',
customIcon: '<string>',
customImage: '<string>',
push_ttl: 604800,
auto_hide: 123,
collapse_key: '<string>',
actions: {
a01: {title: '<string>', link: '<string>'},
a02: {title: '<string>', link: '<string>'}
}
})
};
fetch('https://api.aimtell.com/prod/push/', 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/push/",
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([
'idSite' => 123,
'title' => '<string>',
'body' => '<string>',
'link' => '<string>',
'subscriber_uids' => [
'<string>'
],
'segmentId' => 123,
'alias' => '<string>',
'customIcon' => '<string>',
'customImage' => '<string>',
'push_ttl' => 604800,
'auto_hide' => 123,
'collapse_key' => '<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/push/"
payload := strings.NewReader("{\n \"idSite\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"subscriber_uids\": [\n \"<string>\"\n ],\n \"segmentId\": 123,\n \"alias\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"push_ttl\": 604800,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\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/push/")
.header("X-Authorization-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"idSite\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"subscriber_uids\": [\n \"<string>\"\n ],\n \"segmentId\": 123,\n \"alias\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"push_ttl\": 604800,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\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/push/")
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 \"idSite\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"subscriber_uids\": [\n \"<string>\"\n ],\n \"segmentId\": 123,\n \"alias\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"push_ttl\": 604800,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\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",
"message": "Request received. Push sending shortly.",
"objectId": "5r777x9f8f01d"
}{
"result": "error",
"message": "Error #136."
}{
"result": "error",
"message": "Invalid token.",
"error_code": 71831
}One-Off Notifications
Send Push Notification
Send a Push Notification
POST
/
prod
/
push
/
Send Push Notification
curl --request POST \
--url https://api.aimtell.com/prod/push/ \
--header 'Content-Type: application/json' \
--header 'X-Authorization-Api-Key: <api-key>' \
--data '
{
"idSite": 123,
"title": "<string>",
"body": "<string>",
"link": "<string>",
"subscriber_uids": [
"<string>"
],
"segmentId": 123,
"alias": "<string>",
"customIcon": "<string>",
"customImage": "<string>",
"push_ttl": 604800,
"auto_hide": 123,
"collapse_key": "<string>",
"actions": {
"a01": {
"title": "<string>",
"link": "<string>"
},
"a02": {
"title": "<string>",
"link": "<string>"
}
}
}
'import requests
url = "https://api.aimtell.com/prod/push/"
payload = {
"idSite": 123,
"title": "<string>",
"body": "<string>",
"link": "<string>",
"subscriber_uids": ["<string>"],
"segmentId": 123,
"alias": "<string>",
"customIcon": "<string>",
"customImage": "<string>",
"push_ttl": 604800,
"auto_hide": 123,
"collapse_key": "<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({
idSite: 123,
title: '<string>',
body: JSON.stringify('<string>'),
link: '<string>',
subscriber_uids: ['<string>'],
segmentId: 123,
alias: '<string>',
customIcon: '<string>',
customImage: '<string>',
push_ttl: 604800,
auto_hide: 123,
collapse_key: '<string>',
actions: {
a01: {title: '<string>', link: '<string>'},
a02: {title: '<string>', link: '<string>'}
}
})
};
fetch('https://api.aimtell.com/prod/push/', 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/push/",
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([
'idSite' => 123,
'title' => '<string>',
'body' => '<string>',
'link' => '<string>',
'subscriber_uids' => [
'<string>'
],
'segmentId' => 123,
'alias' => '<string>',
'customIcon' => '<string>',
'customImage' => '<string>',
'push_ttl' => 604800,
'auto_hide' => 123,
'collapse_key' => '<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/push/"
payload := strings.NewReader("{\n \"idSite\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"subscriber_uids\": [\n \"<string>\"\n ],\n \"segmentId\": 123,\n \"alias\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"push_ttl\": 604800,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\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/push/")
.header("X-Authorization-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"idSite\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"subscriber_uids\": [\n \"<string>\"\n ],\n \"segmentId\": 123,\n \"alias\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"push_ttl\": 604800,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\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/push/")
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 \"idSite\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"subscriber_uids\": [\n \"<string>\"\n ],\n \"segmentId\": 123,\n \"alias\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"push_ttl\": 604800,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\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",
"message": "Request received. Push sending shortly.",
"objectId": "5r777x9f8f01d"
}{
"result": "error",
"message": "Error #136."
}{
"result": "error",
"message": "Invalid token.",
"error_code": 71831
}Authorizations
Body
application/json
Site ID
Notification Title
Notification Body
Notification Link
Subscriber UIDS
Segment ID
A subscriber alias (usually a username, userid or email)
url of custom icon to use (recommended size: 250x250)
url of custom image to use (recommended size: 300x500)
Time till a push should expire in seconds. Default is 1 week.
Number of seconds (255 max) until the notification will hide automatically. Default is 0, which is persistent (requires interaction)
replace visible notifications on a subscribers device (e.g. breaking_news)
Action Buttons
Show child attributes
Show child attributes
Response
200
⌘I

