Update Campaign
curl --request PUT \
--url https://api.aimtell.com/prod/campaign/{id} \
--header 'Content-Type: application/json' \
--header 'X-Authorization-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"title": "<string>",
"body": "<string>",
"link": "<string>",
"schedule_date": "2023-12-25",
"segments": "<string>",
"automation": "<string>",
"automation_end": "2023-12-25",
"push_ttl": 123,
"auto_hide": 123,
"collapse_key": "<string>",
"tz_delivery": 123,
"customIcon": "<string>",
"customImage": "<string>",
"status": 1,
"version_b": {
"status": 123,
"title": "<string>",
"body": "<string>",
"link": "<string>",
"customIcon": "<string>",
"customImage": "<string>",
"actions": {
"a01": {
"title": "<string>",
"link": "<string>"
},
"a02": {
"title": "<string>",
"link": "<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/campaign/{id}"
payload = {
"name": "<string>",
"title": "<string>",
"body": "<string>",
"link": "<string>",
"schedule_date": "2023-12-25",
"segments": "<string>",
"automation": "<string>",
"automation_end": "2023-12-25",
"push_ttl": 123,
"auto_hide": 123,
"collapse_key": "<string>",
"tz_delivery": 123,
"customIcon": "<string>",
"customImage": "<string>",
"status": 1,
"version_b": {
"status": 123,
"title": "<string>",
"body": "<string>",
"link": "<string>",
"customIcon": "<string>",
"customImage": "<string>",
"actions": {
"a01": {
"title": "<string>",
"link": "<string>"
},
"a02": {
"title": "<string>",
"link": "<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.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Authorization-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
title: '<string>',
body: JSON.stringify('<string>'),
link: '<string>',
schedule_date: '2023-12-25',
segments: '<string>',
automation: '<string>',
automation_end: '2023-12-25',
push_ttl: 123,
auto_hide: 123,
collapse_key: '<string>',
tz_delivery: 123,
customIcon: '<string>',
customImage: '<string>',
status: 1,
version_b: {
status: 123,
title: '<string>',
body: JSON.stringify('<string>'),
link: '<string>',
customIcon: '<string>',
customImage: '<string>',
actions: {
a01: {title: '<string>', link: '<string>'},
a02: {title: '<string>', link: '<string>'}
}
},
conversion_trigger: {eventCategory: '<string>', eventAction: '<string>'},
actions: {
a01: {title: '<string>', link: '<string>'},
a02: {title: '<string>', link: '<string>'}
}
})
};
fetch('https://api.aimtell.com/prod/campaign/{id}', 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/campaign/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'title' => '<string>',
'body' => '<string>',
'link' => '<string>',
'schedule_date' => '2023-12-25',
'segments' => '<string>',
'automation' => '<string>',
'automation_end' => '2023-12-25',
'push_ttl' => 123,
'auto_hide' => 123,
'collapse_key' => '<string>',
'tz_delivery' => 123,
'customIcon' => '<string>',
'customImage' => '<string>',
'status' => 1,
'version_b' => [
'status' => 123,
'title' => '<string>',
'body' => '<string>',
'link' => '<string>',
'customIcon' => '<string>',
'customImage' => '<string>',
'actions' => [
'a01' => [
'title' => '<string>',
'link' => '<string>'
],
'a02' => [
'title' => '<string>',
'link' => '<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/campaign/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"automation_end\": \"2023-12-25\",\n \"push_ttl\": 123,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\n \"tz_delivery\": 123,\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"status\": 1,\n \"version_b\": {\n \"status\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n },\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("PUT", 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.put("https://api.aimtell.com/prod/campaign/{id}")
.header("X-Authorization-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"automation_end\": \"2023-12-25\",\n \"push_ttl\": 123,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\n \"tz_delivery\": 123,\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"status\": 1,\n \"version_b\": {\n \"status\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n },\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/campaign/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Authorization-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"automation_end\": \"2023-12-25\",\n \"push_ttl\": 123,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\n \"tz_delivery\": 123,\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"status\": 1,\n \"version_b\": {\n \"status\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n },\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": "133321"
}{
"result": "error",
"message": "Error #136."
}{
"result": "error",
"message": "Please specify a valid auth_token."
}Manual Campaigns
Update Campaign
Updates a Specific Campaign
NOTE: When updating a campaign with A/B testing enabled, the version_b status param (1 or 2) must be included to ensure that parameters shared by A and B versions are updated in both campaigns (schedule_date, segments, automation, automation_end, push_ttl, auto_hide, tz_delivery, status). When updating the status of a campaign with A/B testing enabled, both the status param and the version_b status param must be set.
PUT
/
prod
/
campaign
/
{id}
Update Campaign
curl --request PUT \
--url https://api.aimtell.com/prod/campaign/{id} \
--header 'Content-Type: application/json' \
--header 'X-Authorization-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"title": "<string>",
"body": "<string>",
"link": "<string>",
"schedule_date": "2023-12-25",
"segments": "<string>",
"automation": "<string>",
"automation_end": "2023-12-25",
"push_ttl": 123,
"auto_hide": 123,
"collapse_key": "<string>",
"tz_delivery": 123,
"customIcon": "<string>",
"customImage": "<string>",
"status": 1,
"version_b": {
"status": 123,
"title": "<string>",
"body": "<string>",
"link": "<string>",
"customIcon": "<string>",
"customImage": "<string>",
"actions": {
"a01": {
"title": "<string>",
"link": "<string>"
},
"a02": {
"title": "<string>",
"link": "<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/campaign/{id}"
payload = {
"name": "<string>",
"title": "<string>",
"body": "<string>",
"link": "<string>",
"schedule_date": "2023-12-25",
"segments": "<string>",
"automation": "<string>",
"automation_end": "2023-12-25",
"push_ttl": 123,
"auto_hide": 123,
"collapse_key": "<string>",
"tz_delivery": 123,
"customIcon": "<string>",
"customImage": "<string>",
"status": 1,
"version_b": {
"status": 123,
"title": "<string>",
"body": "<string>",
"link": "<string>",
"customIcon": "<string>",
"customImage": "<string>",
"actions": {
"a01": {
"title": "<string>",
"link": "<string>"
},
"a02": {
"title": "<string>",
"link": "<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.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Authorization-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
title: '<string>',
body: JSON.stringify('<string>'),
link: '<string>',
schedule_date: '2023-12-25',
segments: '<string>',
automation: '<string>',
automation_end: '2023-12-25',
push_ttl: 123,
auto_hide: 123,
collapse_key: '<string>',
tz_delivery: 123,
customIcon: '<string>',
customImage: '<string>',
status: 1,
version_b: {
status: 123,
title: '<string>',
body: JSON.stringify('<string>'),
link: '<string>',
customIcon: '<string>',
customImage: '<string>',
actions: {
a01: {title: '<string>', link: '<string>'},
a02: {title: '<string>', link: '<string>'}
}
},
conversion_trigger: {eventCategory: '<string>', eventAction: '<string>'},
actions: {
a01: {title: '<string>', link: '<string>'},
a02: {title: '<string>', link: '<string>'}
}
})
};
fetch('https://api.aimtell.com/prod/campaign/{id}', 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/campaign/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'title' => '<string>',
'body' => '<string>',
'link' => '<string>',
'schedule_date' => '2023-12-25',
'segments' => '<string>',
'automation' => '<string>',
'automation_end' => '2023-12-25',
'push_ttl' => 123,
'auto_hide' => 123,
'collapse_key' => '<string>',
'tz_delivery' => 123,
'customIcon' => '<string>',
'customImage' => '<string>',
'status' => 1,
'version_b' => [
'status' => 123,
'title' => '<string>',
'body' => '<string>',
'link' => '<string>',
'customIcon' => '<string>',
'customImage' => '<string>',
'actions' => [
'a01' => [
'title' => '<string>',
'link' => '<string>'
],
'a02' => [
'title' => '<string>',
'link' => '<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/campaign/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"automation_end\": \"2023-12-25\",\n \"push_ttl\": 123,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\n \"tz_delivery\": 123,\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"status\": 1,\n \"version_b\": {\n \"status\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n },\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("PUT", 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.put("https://api.aimtell.com/prod/campaign/{id}")
.header("X-Authorization-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"automation_end\": \"2023-12-25\",\n \"push_ttl\": 123,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\n \"tz_delivery\": 123,\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"status\": 1,\n \"version_b\": {\n \"status\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n },\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/campaign/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Authorization-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"schedule_date\": \"2023-12-25\",\n \"segments\": \"<string>\",\n \"automation\": \"<string>\",\n \"automation_end\": \"2023-12-25\",\n \"push_ttl\": 123,\n \"auto_hide\": 123,\n \"collapse_key\": \"<string>\",\n \"tz_delivery\": 123,\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"status\": 1,\n \"version_b\": {\n \"status\": 123,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"link\": \"<string>\",\n \"customIcon\": \"<string>\",\n \"customImage\": \"<string>\",\n \"actions\": {\n \"a01\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n },\n \"a02\": {\n \"title\": \"<string>\",\n \"link\": \"<string>\"\n }\n }\n },\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": "133321"
}{
"result": "error",
"message": "Error #136."
}{
"result": "error",
"message": "Please specify a valid auth_token."
}Authorizations
Path Parameters
Campaign ID
Body
application/json
Name of Campaign
Push Title
Push Body
Push Link
DateTime (i.e. 2017-08-25 21:16:50)
Segments
Automation (d = daily, w = weekly, m = monthly, n = none)
Automation End Date (e.g. 2017-08-25 17:00:00)
Expiration Time (in seconds)
Auto Hide (in seconds)
replace visible notifications on a subscribers device replace visible notifications on a subscribers device (e.g. breaking_news)
deliver based on user's timezone (set 0 for false, 1 for true)
url of custom icon to use (recommended size: 250x250)
url of custom image to use (recommended size: 300x500)
set 1 for draft, 2 for scheduled
(optional) Version B for A/B test campaign
Show child attributes
Show child attributes
Show child attributes
Show child attributes
action buttons
Show child attributes
Show child attributes
Response
200