Presets API
List of methods for working with presets
createPreset
POST https://api.pushwoosh.com/json/1.3/createPreset
Creates a new preset.
Request Body
{
"status_code":200,
"status_message":"OK"
}Example
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // required, string. API access token from Pushwoosh Control Panel.
"name": "PRESET_NAME", // required, string.
"applicationCode": "XXXXX-XXXXX", // required, string. Pushwoosh application code.
"applicationGroupCode": "AAAAA-BBBBB", // optional, string. Can be used instead of "applicationCode".
"campaignCode": "CCCCC-DDDDD", // optional, string. Campaign code.
"content": { // required, object. Contains message data.
"message": { // required, string or object. Message content. In case it's a string, the default language will be used.
"en": "English message", // Message content localized for different languages. Only ISO 639-1:2002 for language codes.
"fr": "French message"
},
"title": { // optional, string or object. For multilanguage, set title for each language in the object. Ignored if platform-specific titles are specified (e.g., 'ios_title', 'android-header', etc.; see the platform-specific parameters examples in the /createMessage API).
"en": "English title", // Message content localized for different languages. Only ISO 639-1:2002 for language codes.
"fr": "French title"
},
"subtitle": { // // optional, string or object. For multilanguage, set title for each language in the object. Ignored if platform-specific subtitles are specified (e.g., 'ios_subtitle', etc.; see the platform-specific parameters examples in the /createMessage API).
"en": "English subtitle",
"fr": "French subtitle"
},
"action": { // optional, object. Action to be performed once a user opens a message.
"type": "url", // optional, string. Type of action. Available types: `url`, `deepLink`, `richMedia`, `openApp`(default).
"options": { // optional, object. Options for action types. Required for all action types except for `openApp`.
"url": "http://example.com", // required for `url` action type, string. Will be shortened if shortener is defined.
"shortener": 2, // optional, integer. Available values: 0 — do not minimize, 2 — bit.ly. If no shortener is specified, bit.ly shortener will be used by default.
"richMediaCode": "BBBBB-AAAAA", // required for `richMedia` action type, string. Rich Media code from Pushwoosh Control Panel.
"id": 123, // required for "deepLink" action type, integer. Deep Link ID.
"params": { // optional, custom parameters, required for "deepLink" action type, array.
"param1": "value1",
"param2": "value2"
}
}
},
"userData": { // optional, object. Custom user data. Will be passed as "u" parameter in the payload (converted to JSON string).
"CustomData": "value"
},
"platforms": {
"ios": {
"sound": "default",
"silent": 1,
"ttl": 604800,
"rootParams": {
"rule_id": "12345",
"screen_id": "34567"
},
"interruptionLevel": "active"
},
"android": {
"rootParams": {
"rule_id": "12345",
"screen_id": "34567"
}
}
}
},
"scheduling": { // optional, object. Scheduling options.
"sendRate": 1000 // optional, integer. Throttling. Valid values are from 100 to 1000 pushes/second.
},
"segmentation": { // required, object. Segmentation options.
"filter": "FILTER NAME", // optional, string. Filter name from your Pushwoosh Control Panel.
"platforms": [11,3] // required, array. The list of platforms IDs: 1 — iOS; 3 — Android; 7 — OS X; 8 — Windows 8; 9 — Amazon; 10 — Safari; 11 — Chrome; 12 — Firefox; ignored if "devices" < 10
}
}
}For platform-specific parameters, please refer to /createMessage.
getPreset
POST https://api.pushwoosh.com/json/1.3/getPreset
Retrieves the parameters of the specific push preset.
Request Body
{
"status_code":200,
"status_message":"OK",
"response":{
"preset":{
"code":"XXXXX-XXXXX",
"name":"Full preset",
"page_id":26,
"url":null,
"content":{
"en":"Some eng message",
"ru":"\u041a\u0430\u043a\u043e\u0439-\u0442\u043e \u0442\u0435\u043a\u0441\u0442"
},
"properties":{
"ignore_user_timezone":1,
"ios_badges":"5",
"ios_sound":"default",
"ios_ttl":"43200",
"android_sound":"Sound1.wav",
"android_custom_icon":"icon.png",
"android_header":"android_header",
"android_gcm_ttl":"43200",
"wns_type":"toast",
"wns_content":{
"template":"ToastImageAndText02",
"lang-en":{
"headlinetext":"Title",
"bodytext":"super text"
},
"languages":["en", "zh", "it", "sv", "de", "fr", "ru", "pt", "nl", "es"],
"lang-zh":{
"headlinetext":"",
"bodytext":""
},
"lang-it":{
"headlinetext":"",
"bodytext":""
},
"lang-sv":{
"headlinetext":"",
"bodytext":""
},
"lang-de":{
"headlinetext":"",
"bodytext":""
},
"lang-fr":{
"headlinetext":"",
"bodytext":""
},
"lang-ru":{
"headlinetext":"",
"bodytext":""
},
"lang-pt":{
"headlinetext":"",
"bodytext":""
},
"lang-nl":{
"headlinetext":"",
"bodytext":""
},
"lang-es":{
"headlinetext":"",
"bodytext":""
},
"imagesource":"http:\/\/image.com\/jpg"
},
"blackberry_header":"Some Header",
"adm_sound":"song",
"adm_custom_icon":"i5.bmp",
"adm_header":"Amazon Header",
"adm_ttl":"7200",
"wp_type":"Tile",
"wp_background":"i1.png",
"wp_count":5,
"wp_backbackground":"i2.png",
"wp_backtitle":"back title",
"wp_backcontent":"back content",
"safari_title":"Safari title",
"safari_action":"OK",
"safari_url_args":["hello.com", ""],
"safari_ttl":"43200",
"userdata":"{\"custom\":\"data\"}",
"created_via":"CP",
"user_id":2,
"filter_id":"1"
},
"platforms":[1,3,2,5,9,4,7,8,10]
}
}
}Example
{
"request":{
"auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
"preset_code": "AAAAA-BBBBB" // required, push preset code to retrieve information for
}
}listPresets
POST https://api.pushwoosh.com/json/1.3/listPresets
Retrieves the list of presets created for the app.
Request Body
{
"status_code": 200,
"status_message": "OK",
"response": {
"presets": []
}
}{
"status_code": 200,
"status_message": "OK",
"response": {
"presets": [
{
"name": "test",
"code": "AAAAA-BBBBB"
}
]
}
}{
"request": {
"auth" : "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
"application": "XXXXX-XXXXX" // required, Pushwoosh app code
}
}deletePreset
POST https://api.pushwoosh.com/json/1.3/deletePreset
Deletes a preset from your account.
Request Body
{
"status_code": 200,
"status_message": "OK",
"response": null
}Example
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
"preset_code": "AAAAA-BBBBB" // required, code of a preset to delete
}
}Last updated