Skip to main content
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>"
    }
  }
}
'
{
  "result": "success",
  "message": "Request received. Push sending shortly.",
  "objectId": "5r777x9f8f01d"
}

Authorizations

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

Body

application/json
idSite
integer<int32>
required

Site ID

title
string
required

Notification Title

body
string
required

Notification Body

Notification Link

subscriber_uids
string[]

Subscriber UIDS

segmentId
integer<int32>

Segment ID

alias
string

A subscriber alias (usually a username, userid or email)

customIcon
string

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

customImage
string

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

push_ttl
integer<int32>
default:604800

Time till a push should expire in seconds. Default is 1 week.

auto_hide
integer<int32>

Number of seconds (255 max) until the notification will hide automatically. Default is 0, which is persistent (requires interaction)

collapse_key
string

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

actions
object

Action Buttons

Response

200