POST Push API

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

On the Cloud, this API is available via SSL-secured HTTPS connection 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”

PUSH Notifications are NOT supported on our trial iOS and Android accounts as no Google/Apple accounts are setup for trial apps.

---

Endpoints & API Explorer

Node	API Endpoint	API Explorer
US	/api/v2/push	Model Description/Schema & Parameters

---

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.

Name	Type	Description	Required
UserId	String	Specify the target user via their API identifier.	✓*
UserEmail	String	Specify the target user via their email address.	✓*
UserExternalId	String	Specify the target user via their external identifier.	✓*
Title	String	A short message title.	✓
Body	String	A short message body.	✓
Sound	Boolean	Play a sound on the device when notification is received.
ExpirySecs	Integer	Removes message display on device after the given period.
CompanyId	Integer	Your unique Company Id found on the Organisation Setup page of the secure website.	✓
IntegrationKey	String	Your unique Integration Key found on the Organisation 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 Postman API Platform.

Request URL

Push API Endpoint URL (EU Node)

https://eforms.mobileform.net:443/api/v2/push

Request Body

Sample JSON body

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

• Related Articles

• POST Repository API (Create)

  The POST Repository API registers new content from a company account into the Repository. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response ...

• POST Repository API (Create Installations)

  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. The format query string parameter ...

• POST Folder

  The POST Folder API creates a new folder in the company’s account. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response format. Specify either ...

• POST Usergroup

  This API allows you to create a new user group. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response format. Specify either XML or JSON. ...

• POST Company

  This request method lets you create a new company account through the API, specifying the company details as parameters. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter ...