POST v2/apps/{appId}/push
Send a push notification to the application
Request Information
URI Parameters
Name | Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
appId | integer |
Application Id
Additional Info :
Required |
Body Parameters
Push Notification payload
PushRequestName | Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Title | string |
Title of the Notification, displayed on the messages screen and on the Android notification tray
Additional Info :
Required Length between 0 and 250 |
|||||||||||
Message | string |
Message to send in the notification, displayed to the App User when received or viewed in the App
Additional Info :
Required |
|||||||||||
Url | string |
Optional Url to attach with the message. App Users will be shown the link and can tap on it to navigate to it
Additional Info :
Length between 0 and 250 |
|||||||||||
PreviewerOnly | boolean |
If true, the notification will only be received/displayed on the Previewer App, otherwise it is sent to all devices with the app installed |
|||||||||||
IsExternalLink | boolean |
If true, the Url specified in the message will open in the device's native browser instead of loading it inside of the application. Has no effect if no Url is specified |
|||||||||||
Categories | string |
A delimited string containing the categories to attach to a push |
|||||||||||
Target | string |
Specific target that the push notification will be send to. |
|||||||||||
Language | string |
Target specific language that the mobile user is using leaving this empty will send it to any end users. |
|||||||||||
DataInfo | string |
Additional information of the push notification |
Request Formats
{ "title": "Testing The Previewer", "message": "This is a Test push to Make sure this is working...", "url": "", "previewerOnly": true, "isExternalLink": false, "categories": null, "target": null, "language": null, "dataInfo": null }
<PushRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models"> <Categories i:nil="true" /> <DataInfo i:nil="true" /> <IsExternalLink>false</IsExternalLink> <Language i:nil="true" /> <Message>This is a Test push to Make sure this is working...</Message> <PreviewerOnly>true</PreviewerOnly> <Target i:nil="true" /> <Title>Testing The Previewer</Title> <Url></Url> </PushRequest>
Response Information
Resource Description
Details of the sent notification
PushResponseName | Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Id | integer |
Id of the Push Notification in the system |
|||||||||||
Title | string |
Title of the push notification, displayed on the device |
|||||||||||
Url | string |
Attached Url of the notification if one was sent |
|||||||||||
Message | string |
Actual message of the notification |
|||||||||||
DateSent | date |
UTC Date and Time the notification was sent |
|||||||||||
IsGeo | boolean |
True if the notification was a Geo/Location based notification |
|||||||||||
PreviewerOnly | boolean |
True if the notification was only sent/displayed to the Previewer App instead of the actual built app |
|||||||||||
IsExternalLink | boolean |
True if the Url is to be opened in a seperate app (browser) on the device. Could be true even if no Url is specified, but typically is false in that case. |
|||||||||||
MediaImage | string |
Image the will be displayed on the details view. |
|||||||||||
IsTenant | boolean |
Image the will be displayed on the details view. |
|||||||||||
Target | string |
Target of the push being sent |
|||||||||||
Language | string |
Language set when sent by the user. |
|||||||||||
Sources | Collection of string |
Source where the push notification came from |
|||||||||||
DataInfo | string |
Additional information of the push notification |
Response Formats
{ "id": 34, "title": "Welcome to our app", "url": "", "message": "Use the Coupon Code APP2016 to get $10 off you purchase.", "dateSent": "2024-11-28T13:27:00.4867213Z", "isGeo": false, "previewerOnly": true, "isExternalLink": false, "mediaImage": null, "isTenant": false, "target": null, "language": null, "sources": null, "dataInfo": null }
<PushResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models"> <DataInfo i:nil="true" /> <DateSent>2024-11-28T13:27:00.4867213+00:00</DateSent> <Id>34</Id> <IsExternalLink>false</IsExternalLink> <IsGeo>false</IsGeo> <IsTenant>false</IsTenant> <Language i:nil="true" /> <MediaImage i:nil="true" /> <Message>Use the Coupon Code APP2016 to get $10 off you purchase.</Message> <PreviewerOnly>true</PreviewerOnly> <Sources xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <Target i:nil="true" /> <Title>Welcome to our app</Title> <Url></Url> </PushResponse>