GET v2/apps/{appId}/tenants/{tenantId}/push

Retrieve all push messages for a tenant

Request Information

URI Parameters

Name Type Description
appId integer

Application Id

Additional Info :

Required

tenantId integer

Id of the Tenant to retrieve pushes for

Additional Info :

Required

Body Parameters

None.

Response Information

Resource Description

Collection of PushResponse
Name 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-12-08T11:27:08.9875613Z",
    "isGeo": false,
    "previewerOnly": true,
    "isExternalLink": false,
    "mediaImage": null,
    "isTenant": false,
    "target": null,
    "language": null,
    "sources": null,
    "dataInfo": null
  },
  {
    "id": 42,
    "title": "Save a Ton with This Coupon!",
    "url": "http://www.appnotch.com/CouponCodeGenerator",
    "message": "Use the Coupon Code ABC123 For a 20% Discount this week only!",
    "dateSent": "2024-12-16T11:27:08.9875613Z",
    "isGeo": false,
    "previewerOnly": false,
    "isExternalLink": false,
    "mediaImage": null,
    "isTenant": false,
    "target": null,
    "language": null,
    "sources": null,
    "dataInfo": null
  },
  {
    "id": 45,
    "title": "We have a new location near you!",
    "url": "http://www.mystore.com/stlouislocation/",
    "message": "St Louisians, There is a new Store Located in Soulard",
    "dateSent": "2024-12-18T11:27:08.9875613Z",
    "isGeo": true,
    "previewerOnly": false,
    "isExternalLink": false,
    "mediaImage": null,
    "isTenant": false,
    "target": null,
    "language": null,
    "sources": null,
    "dataInfo": null
  }
]
<ArrayOfPushResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AppNotch.Converter.Api.Server.Models">
  <PushResponse>
    <DataInfo i:nil="true" />
    <DateSent>2024-12-08T11:27:08.9875613+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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <Target i:nil="true" />
    <Title>Welcome to our app</Title>
    <Url></Url>
  </PushResponse>
  <PushResponse>
    <DataInfo i:nil="true" />
    <DateSent>2024-12-16T11:27:08.9875613+00:00</DateSent>
    <Id>42</Id>
    <IsExternalLink>false</IsExternalLink>
    <IsGeo>false</IsGeo>
    <IsTenant>false</IsTenant>
    <Language i:nil="true" />
    <MediaImage i:nil="true" />
    <Message>Use the Coupon Code ABC123 For a 20% Discount this week only!</Message>
    <PreviewerOnly>false</PreviewerOnly>
    <Sources xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <Target i:nil="true" />
    <Title>Save a Ton with This Coupon!</Title>
    <Url>http://www.appnotch.com/CouponCodeGenerator</Url>
  </PushResponse>
  <PushResponse>
    <DataInfo i:nil="true" />
    <DateSent>2024-12-18T11:27:08.9875613+00:00</DateSent>
    <Id>45</Id>
    <IsExternalLink>false</IsExternalLink>
    <IsGeo>true</IsGeo>
    <IsTenant>false</IsTenant>
    <Language i:nil="true" />
    <MediaImage i:nil="true" />
    <Message>St Louisians, There is a new Store Located in Soulard</Message>
    <PreviewerOnly>false</PreviewerOnly>
    <Sources xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <Target i:nil="true" />
    <Title>We have a new location near you!</Title>
    <Url>http://www.mystore.com/stlouislocation/</Url>
  </PushResponse>
</ArrayOfPushResponse>