TABLE OF CONTENTS

  • Parameters
  • Example


ADDITIONAL INFO

  • API Explorer
  • General Information

 

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.

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 is found on the Organization Setup page of the secure website.

✓

IntegrationKey

String

Your 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://secure.amplusforms.com/apiexplorer#!/push/postv2push

 

 

Request Body

{

  "UserId": "",

  "UserEmail": "",

  "UserExternalId": "",

  "Title": "",

  "Body": "",

  "Sound": false,

  "ExpirySecs": 0,

  "CompanyId": 0,

  "IntegrationKey": ""

}