Skip to main content
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>"
    }
  }
}
'
{
  "result": "success",
  "campaignId": 72129
}

Authorizations

X-Authorization-Api-Key
string
header
default:""
required

Body

application/json
name
string
required

Campaign Name

idSite
string
required

Site ID

title
string

Push Title

body
string

Push Body

Link

schedule_date
string<date>

DateTime (e.g. 2017-08-25 21:16:50)

segments
string

Segments

automation
string

Automation (d = daily, w = weekly, m = monthly, n = none)

push_ttl
integer<int32>

expiration time (in seconds)

collapse_key
string

replace visible notifications on a subscribers device (e.g. breaking_news)

auto_hide
integer<int32>

Auto Hide (in seconds)

tz_delivery
integer<int32>

deliver based on user's timezone (set 0 for false, 1 for true)

status
string
default:1

1 = draft, 2 = scheduled

customIcon
string

url of custom icon to use (recommended size: 250x250)

customImage
string

url of custom image to use (recommended size: 300x500)

conversion_trigger
object
actions
object

action buttons

Response

200