Our documentation is changing, please click here to enjoy it!

Skip to end of metadata
Go to start of metadata

This API route is used to create a Scheduled Alarm.

Operations

POST

/v1/me/apps/:partnerId/alarms

ParameterModel
headers
Generic Accengage headers
partnerId
See Partner ID for the partnerId URL parameter
body
Alarms

 


 

List

 


 

Settings

 


 

ExclusionRanges

 


 

Segments

 


 

Triggers

 


 

Geolocation

 


 

Beacon

 


 

State

 


 

CustomParams

 


 

Programmation

 


 

 

AndroidMessage

 


 

AndroidButton

 

 

iOSMessage

 


 

iOSButton

 

For events objects, the expected identifier is the "code" of the event (available in advanced settings on the interface).

For views objects, the expected identifier is the "value" of the View (available in advanced settings on the interface).

You can give any custom field by using the ${:yourCustomField} in your String (field name in DB between "${" and "}")

Response
returnCodeDescriptionModelHeaders

200

 

OK

400

Validation failed for the given message

Webservice can only be used for Android or iOS messages

The template must be the same for each message

   404

Can not find [ressource] with id ...

The geolocation, event, view, beacon, or state could not be found for this application

Examples

RequestBodyCodeResponseReason

POST /v1/me/apps/:myPartnerId/alarms

 200
The message has been successfully created.
  • No labels