POST
/
notifications?c=push
curl --request POST \
  --url 'https://api.onesignal.com/notifications?c=push' \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "app_id": "YOUR_APP_ID",
  "include_aliases": {
    "external_id": [
      "<string>"
    ],
    "onesignal_id": [
      "<string>"
    ]
  },
  "target_channel": "push",
  "include_subscription_ids": [
    "<string>"
  ],
  "included_segments": [
    "<string>"
  ],
  "excluded_segments": [
    "<string>"
  ],
  "filters": [
    {
      "field": "first_session",
      "key": "<string>",
      "relation": ">",
      "value": "1"
    }
  ],
  "contents": {
    "en": "<string>"
  },
  "headings": {
    "en": "<string>"
  },
  "subtitle": {
    "en": "<string>"
  },
  "name": "<string>",
  "template_id": "<string>",
  "custom_data": {},
  "ios_attachments": {
    "id": "<string>"
  },
  "big_picture": "<string>",
  "huawei_big_picture": "<string>",
  "adm_big_picture": "<string>",
  "chrome_web_image": "<string>",
  "small_icon": "<string>",
  "huawei_small_icon": "<string>",
  "adm_small_icon": "<string>",
  "large_icon": "<string>",
  "huawei_large_icon": "<string>",
  "adm_large_icon": "<string>",
  "chrome_web_icon": "<string>",
  "firefox_icon": "<string>",
  "chrome_web_badge": "<string>",
  "android_channel_id": "<string>",
  "existing_android_channel_id": "<string>",
  "huawei_channel_id": "<string>",
  "huawei_existing_channel_id": "<string>",
  "huawei_category": "<string>",
  "huawei_msg_type": "<string>",
  "huawei_bi_tag": "<string>",
  "priority": 123,
  "ios_interruption_level": "<string>",
  "ios_sound": "<string>",
  "ios_badgeType": "<string>",
  "ios_badgeCount": 123,
  "android_accent_color": "<string>",
  "huawei_accent_color": "<string>",
  "url": "<string>",
  "app_url": "<string>",
  "web_url": "<string>",
  "target_content_identifier": "<string>",
  "buttons": {
    "id": "<string>",
    "text": "<string>",
    "icon": "<string>"
  },
  "web_buttons": {
    "id": "<string>",
    "text": "<string>",
    "url": "<string>"
  },
  "thread_id": "<string>",
  "ios_relevance_score": 123,
  "android_group": "<string>",
  "adm_group": "<string>",
  "ttl": 123,
  "collapse_id": "<string>",
  "web_push_topic": "<string>",
  "data": {},
  "content_available": true,
  "ios_category": "<string>",
  "apns_push_type_override": "<string>",
  "isIos": true,
  "isAndroid": true,
  "isHuawei": true,
  "isAnyWeb": true,
  "isChromeWeb": true,
  "isFirefox": true,
  "isSafari": true,
  "isWP_WNS": true,
  "isAdm": true,
  "send_after": "<string>",
  "delayed_option": "<string>",
  "delivery_time_of_day": "<string>",
  "throttle_rate_per_minute": 123,
  "enable_frequency_cap": true,
  "idempotency_key": "<string>"
}'
{
  "id": "<string>",
  "external_id": "<string>",
  "errors": {
    "invalid_aliases": {
      "external_id": [
        "[\"user_id_1\", \"user_id_1\", \"user_id_2\"]"
      ],
      "onesignal_id": [
        "[\"1589641e-bed1-4325-bce4-d2234e578884\", \"1589641e-bed1-4325-bce4-d2234e578884\", \"1589641e-bed1-4325-bce4-d2234e578884\"]"
      ]
    },
    "invalid_player_ids": [
      "<string>"
    ]
  }
}

Overview

The Create message API allows you to send push notifications, emails, and SMS to your users. This guide is specific for push. See Email or SMS to send to those channels.

Ensure your application is properly configured by following the Mobile SDK Setup and/or Web SDK Setup guides. You should see subscribed push Subscriptions in your OneSignal dashboard to send them messages.


Headers

Authorization
string
default:Key YOUR_APP_API_KEY
required

Your App API key with prefix Key. See Keys & IDs.

Body

application/json

Response

200
application/json

200

The response is of type object.

POST
/
notifications?c=push
curl --request POST \
  --url 'https://api.onesignal.com/notifications?c=push' \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "app_id": "YOUR_APP_ID",
  "include_aliases": {
    "external_id": [
      "<string>"
    ],
    "onesignal_id": [
      "<string>"
    ]
  },
  "target_channel": "push",
  "include_subscription_ids": [
    "<string>"
  ],
  "included_segments": [
    "<string>"
  ],
  "excluded_segments": [
    "<string>"
  ],
  "filters": [
    {
      "field": "first_session",
      "key": "<string>",
      "relation": ">",
      "value": "1"
    }
  ],
  "contents": {
    "en": "<string>"
  },
  "headings": {
    "en": "<string>"
  },
  "subtitle": {
    "en": "<string>"
  },
  "name": "<string>",
  "template_id": "<string>",
  "custom_data": {},
  "ios_attachments": {
    "id": "<string>"
  },
  "big_picture": "<string>",
  "huawei_big_picture": "<string>",
  "adm_big_picture": "<string>",
  "chrome_web_image": "<string>",
  "small_icon": "<string>",
  "huawei_small_icon": "<string>",
  "adm_small_icon": "<string>",
  "large_icon": "<string>",
  "huawei_large_icon": "<string>",
  "adm_large_icon": "<string>",
  "chrome_web_icon": "<string>",
  "firefox_icon": "<string>",
  "chrome_web_badge": "<string>",
  "android_channel_id": "<string>",
  "existing_android_channel_id": "<string>",
  "huawei_channel_id": "<string>",
  "huawei_existing_channel_id": "<string>",
  "huawei_category": "<string>",
  "huawei_msg_type": "<string>",
  "huawei_bi_tag": "<string>",
  "priority": 123,
  "ios_interruption_level": "<string>",
  "ios_sound": "<string>",
  "ios_badgeType": "<string>",
  "ios_badgeCount": 123,
  "android_accent_color": "<string>",
  "huawei_accent_color": "<string>",
  "url": "<string>",
  "app_url": "<string>",
  "web_url": "<string>",
  "target_content_identifier": "<string>",
  "buttons": {
    "id": "<string>",
    "text": "<string>",
    "icon": "<string>"
  },
  "web_buttons": {
    "id": "<string>",
    "text": "<string>",
    "url": "<string>"
  },
  "thread_id": "<string>",
  "ios_relevance_score": 123,
  "android_group": "<string>",
  "adm_group": "<string>",
  "ttl": 123,
  "collapse_id": "<string>",
  "web_push_topic": "<string>",
  "data": {},
  "content_available": true,
  "ios_category": "<string>",
  "apns_push_type_override": "<string>",
  "isIos": true,
  "isAndroid": true,
  "isHuawei": true,
  "isAnyWeb": true,
  "isChromeWeb": true,
  "isFirefox": true,
  "isSafari": true,
  "isWP_WNS": true,
  "isAdm": true,
  "send_after": "<string>",
  "delayed_option": "<string>",
  "delivery_time_of_day": "<string>",
  "throttle_rate_per_minute": 123,
  "enable_frequency_cap": true,
  "idempotency_key": "<string>"
}'
{
  "id": "<string>",
  "external_id": "<string>",
  "errors": {
    "invalid_aliases": {
      "external_id": [
        "[\"user_id_1\", \"user_id_1\", \"user_id_2\"]"
      ],
      "onesignal_id": [
        "[\"1589641e-bed1-4325-bce4-d2234e578884\", \"1589641e-bed1-4325-bce4-d2234e578884\", \"1589641e-bed1-4325-bce4-d2234e578884\"]"
      ]
    },
    "invalid_player_ids": [
      "<string>"
    ]
  }
}

Overview

The Create message API allows you to send push notifications, emails, and SMS to your users. This guide is specific for push. See Email or SMS to send to those channels.

Ensure your application is properly configured by following the Mobile SDK Setup and/or Web SDK Setup guides. You should see subscribed push Subscriptions in your OneSignal dashboard to send them messages.


Headers

Authorization
string
default:Key YOUR_APP_API_KEY
required

Your App API key with prefix Key. See Keys & IDs.

Body

application/json

Response

200
application/json

200

The response is of type object.