POST Push API

POST Push API

TABLE OF CONTENTS


This request method allows you to send a push notification to a specified user.  

This API is available via SSL-secured HTTPS connection on the Cloud using the REST POST verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.


/api/v2/push?format=xml/json


You may use either JSON or XML formats in your POST submission.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".

If no ContentType is specified, XML format is assumed.  


All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters

The POST verb allows you to send a Push notification to a specified user.
The required and optional parameters for a POST call to the Push API are outlined below.

NameTypeDescriptionRequired
UserId
StringSpecify the target user via their API identifier.
✓*
UserEmail
StringSpecify the target user via their email address.
✓*
UserExternalId
StringSpecify the target user via their external identifier.
✓*
Title
StringA short message title.
✓
Body
StringA short message body.
✓
Sound
BooleanPlay a sound on the device when notification is received.

ExpirySecsIntegerRemoves message display on device after the given period.
CompanyIdIntegerYour unique Company ID is found on the Organization Setup page of the secure website.
✓
IntegrationKeyStringYour unique Integration Key is found on the Organization Setup page of the secure website.
✓


✓* -  At least one user identifier needs to be specified, either UserId, UserEmail or UserExternalId

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using the Postman API Platform.


Request URL

https://eforms.mobileform.net/apiexplorer#!/push/postv2push
HTML


Request Body

{
  "UserId": "",
  "UserEmail": "",
  "UserExternalId": "",
  "Title": "",
  "Body": "",
  "Sound": false,
  "ExpirySecs": 0,
  "CompanyId": 0,
  "IntegrationKey": ""
}



    • Related Articles

    • API Usage Limits

      Calls to our API are limited to 2500 per day per organization account to avoid abuse or negligent integrations that degrade platform performance. We also have a soft limit of 3 concurrent API connections per organization account. Please contact our ...

    • POST Repository API (Create)

      TABLE OF CONTENTS Parameters Example The POST Repository API registers new content from a company account into the Repository. This API is available via SSL-secured HTTPS connection on the Cloud using the REST POST verb. The format query string ...

    • POST Repository API (Create Installations)

      TABLE OF CONTENTS Parameters Example Using this API endpoint and the POST verb, you can install/update repository item content in a target company account. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. ...

    • POST Screen

      TABLE OF CONTENTS Parameters Example The POST Screen Form API allows you to create a form programmatically rather than in the designer. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query ...

    • POST User

      TABLE OF CONTENTS POST Request POST Response User Response () User () Response Fields API Usage Example POST Request You may use either JSON or XML formats in your request. You indicate this by setting the ContentType HTTP header as ...