Push to an Audience

This API can be used to send notification against an audience. You may use 'Get audiences' API described below to get list of audiences along with their IDs. You can push notifications to an audience using the audience ID.

 

Get Audiences

This API can be used to get the list of audiences created through 'Audience Builder' on iZooto Panel.

 

Definition

 
curl -X GET \ -H "Authentication-Token: {API_TOKEN}" \ "https://apis.izooto.com/v1/audience"
 
Parameters

Sample Code

 
curl -X GET \ -H "Authentication-Token: abc1234defghji89766" \ "https://apis.izooto.com/v1/audience"
 
{"audience": [{"id": 1381,"name": "Frequent-Shoppers","reach": 12324},{"id": 1387"name":"Mobile-Users","reach":2121}]}
 
Here id represents the audience ID against which notification has to be pushed, name represents the 'Audience Name' created on panel, and reach represents the total no. of subscribers that belong to the respective audience.

Send notification to an audience

This API can be used to send notification against an audience. You may use 'Get audiences' API described above to get list of audiences along with their IDs. These IDs can be used to push notifications against using 'Push notification to an audience'.
 
Definition
 
curl -X POST \ - H "Authentication-Token: {API_TOKEN}" \ - H "Content-Type: application/json" \ -d '{ "title" : "{NOTIFICATION_TITLE}", "message" : "{NOTIFICATION_MESSAGE}", "icon_url" : "{ICON_URL}", "banner_url" : "{BANNER_URL}", "landing_url" : "{LANDING_URL}", "actions" : [ { "text" : "{BUTTON1_TEXT}", "url" : "{BUTTON1_URL}" }, { "text" : "{BUTTON2_TEXT}", "url" : "{BUTTON1_URL}" }], "utm_source" : "{UTM_SOURCE}", "utm_medium" : "{UTM_MEDIUM}", "utm_campaign" : "{UTM_CAMPAIGN}", "ttl" : "{TTL_SECONDS}", "target" : { "type : "audience", 
"value" : {AUDIENCE_ID}
} }' "https://apis.izooto.com/v1/notifications"
 
 
Parameters
Sample Code
 
curl -X POST \ - H "Authentication-Token: abc123efgh456ijklmn9786" \ - H "Content-Type: application/json" \ -d '{ "title" : "Limited Period Offer", "message" : "Go Shopping, Save Big", "icon_url" : "https://yourdomain.com/icon.png", "banner_url" : "https://yourdomain.com/large-image.png", "landing_url" : "https://yourdomain.com/offers", "actions" : [ { "text" : "Buy Now", "url" : "https://yourdomain.com/buy-now" }, { "text" : "Compare", "url" : "https://yourdomain.com/compare" }], "utm_source" : "izooto", "utm_medium" : "push_notification", "utm_campaign" : "promotion", "ttl" : "86400", "target" : { "type" : "audience", "value" : 1381 } }' "https://apis.izooto.com/v1/notifications"
 
 

Did this help answer your question?

thumbs up
thumbs down

Thanks for the feedback! 🙏🏽