Send bulk app pushes

Overview

Bulk Push API is a service that sends push notifications to a predefined segment over the web using predefined web services and can be used to send bulk push notifications to the selected segment. 

You can reach the analytics of your bulk push notifications sent via Experience > Message > App Push on Inone. Your pushed will be named {campaignName}-API.

Endpoint and Headers

POST https://mobile.useinsider.com/api/v1/push/bulk

Headers

Body Parameters

Sample Example

Sample Body

Before sending the request, make sure to replace the values in your request body.

App push notifications are sent to a user's last active device.

{
   "api_key":"Your API Key goes here",
   "campaign_name":"Insider API Demo",
   "segment_name":"All People",
   "title":"Your push notification title goes here",
   "content":"Your push content goes here.",
   "deeplink":{
      "your_deeplink_key":"value",
      "your_another_deeplink_key":"value"
   },
   "notification_image":"https://your_image_url.jpg",
   "android_sound":"Your custom sound name for Android goes here",
   "ios_sound":"Your custom sound name for iOS goes here",
   "test_push":true,
   "override_global_freq_cap":true,
   "advanced_push_items":[
      {
         "headline":"Title for the item 1",
         "description":"Description for the item 1",
         "image_url":"https://your_image_url.jpg",
         "deep_links":{
            "your_deeplink_key":"value"
         }
      },
      {
         "headline":"Title for the item 2",
         "description":"Description for the item 2",
         "image_url":"https://your_image_url.jpg",
         "deep_links":{
            "your_deeplink_key":"value"
         }
      },
      {
         "headline":"Title for the item 3",
         "description":"Description for the item 3",
         "image_url":"https://your_image_url.jpg",
         "deep_links":{
            "your_deeplink_key":"value"
         }
      }
   ],
   "preferred_type":"carousel"
}

Sample Responses

• 200 Campaign created successfully

{
    "response": "Campaign Created."
}

• 400 Invalid API Key

{
    "response": "No Partner Found With Api Key."
}

• 422 No Push Message Certificate

{
    "response": "No Push Message Certificate is Provided."
}

Fail Records Messages

Limitations

• All functions must be executed with a simple HTTPS POST request.
• The API key should be provided in the request body. If the key is incorrect, no operation will be executed.
• Each payload can contain only one bulk push campaign.