Preset properties map

Preset property
getPreset key
createPreset key
Value examples
Preset name
preset.name
name
"20% discount"
Push title (use JSON object for multilanguage; multilanguage titles are cross-platform)
preset.title
content.title
string or object
Localized push title
preset.title.en / preset.title.fr/de/es, etc.
content.title.en / content.title.fr/de/es, etc.
"Hi there" 
Push subtitle (same for all platforms)
preset.subtitle
content.subtitle
"Don't miss out"
Push content (use JSON object for multilanguage)
preset.content
content.message
string or object
Localized push content
preset.content.en / preset.content.fr/de/es, etc.
content.message.en / content.message.fr/de/es, etc. 
"Get your 20% discount right now"
Preset properties
preset.properties
-
-
Target Segment name (Filter name)
preset.properties.filter_name
segmentation.filter
"Purchased something"
Send rate limit
preset.properties.send_rate
scheduling.sendRate
1000
Action to be performed by tap on a push
preset.properties.action_type
content.action.type
"deeplink", "richMedia", "url"
Code of the Rich Media to be opened by tap on a push
preset.properties.rich_media_code
content.action.options.richMediaCode
"12345-67890"
URL to be opened by tap on a push
preset.properties.url
content.action.options.url
https://example.com
Deep Link ID to open a specific page
preset.properties.deeplinkUid
content.action.options.id
"33482"
Deep Link params
-
content.action.options.params
{"param1" : "value1"}
Deep Link params
preset.properties.deeplinkParams
content.action.options.params.param1
"{\"promo_id\":\"id\"}"
Custom data
preset.properties.userdata
content.userData
{"key" : "value"}
iOS badge
preset.properties.ios_badge
content.platforms.ios.badge
"0"
iOS mute
preset.properties.ios_sound_off
content.platforms.ios.soundOff
true/false
iOS custom sound
preset.properties.ios_sound
content.platforms.ios.sound
"bubble.wav"
iOS Time-to-Live
preset.properties.ios_ttl
content.platforms.ios.ttl
43200
iOS title (not multilanguage)
preset.properties.ios_title
content.platforms.ios.title
"Hi there"
iOS subtitle
preset.properties.ios_subtitle
content.platforms.ios.subtitle
"Don't miss out"
iOS root params
preset.properties.ios_root_params
content.platforms.ios.rootParams
{"key" : "value"}
iOS interruption level
preset.properties.ios_interruption_level
content.platforms.ios.interruptionLevel
"critical", "time-sensitive", "passive", "active"
iOS Media Attachment
preset.properties.ios_attachment
content.platforms.ios.attachment
https://example.com
iOS silent push
preset.properties.ios_silent
content.platforms.ios.silent
true/false
Android badge
preset.properties.android_badges
content.platforms.android.badge
"0"
Android mute
preset.properties.android_sound_off
content.platforms.android.soundOff
true/false
Android custom sound
preset.properties.android_sound
content.platforms.android.sound
"bubbles.wav"
Android custom icon
preset.properties.android_custom_icon
content.platforms.android.customIcon
https://example.com
Android title (not multilanguage)
preset.properties.android_header
content.platforms.android.header
"Hi there"
Android Time-to-Live
preset.properties.android_gcm_ttl
content.platforms.android.ttl
43200
Android banner
preset.properties.android_banner
content.platforms.android.banner
https://example.com
Android force vibration
preset.properties.android_vibration
content.platforms.android.vibration
true/false
Android LED color
preset.properties.android_led
content.platforms.android.led
"#FFFFFF"
Android priority
preset.properties.android_priority
content.platforms.android.priority
-2, -1, 0, 1, 2
Android root params
preset.properties.android_root_params
content.platforms.android.rootParams
{"key" : "value"}
Android delivery priority
preset.properties.android_delivery_priority
content.platforms.android.deliveryPriority
"normal", "high"
Android image background color
preset.properties.android_ibc
content.platforms.android.ibc
"#FFFFFF"
Android show-on-lockscreen
preset.properties.android_lockscreen
content.platforms.android.lockScreen
true/false
Android silent push
preset.properties.android_silent
content.platforms.android.silent
true/false
Safari title (not multilanguage)
preset.properties.safari_title
content.platforms.safari.title
"Hi there"
Safari button 
preset.properties.safari_action
content.platforms.safari.action
"Click here"
Safari button params
preset.properties.safari_url_args
content.platforms.safari.urlArgs
["firstArgument", "secondArgument"]
Safari Time-to-Live
preset.properties.safari_ttl
content.platforms.safari.ttl
43200
Chrome title (not multilanguage)
preset.properties.chrome_header
content.platforms.chrome.title
"Hi there"
Chrome custom icon
preset.properties.chrome_icon
content.platforms.chrome.icon
https://example.com
Chrome Time-to-Live
preset.properties.chrome_gcm_ttl
content.platforms.chrome.ttl
43200
Chrome push display duration
preset.properties.chrome_duration
content.platforms.chrome.duration
50
Chrome push image
preset.properties.chrome_image
content.platforms.chrome.image
https://example.com
Chrome button params
-
content.platforms.chrome.button1
{"text" : "Learn more", "url" : "https://example.com"}
Chrome first button text
preset.properties.chrome_button_text1
content.platforms.chrome.button1.text
"Learn more"
Chrome first button URL
preset.properties.chrome_button_url1
content.platforms.chrome.button1.url
https://example.com
Chrome second button text 
preset.properties.chrome_button_text2
content.platforms.chrome.button2.text
"Later"
Chrome second button URL
preset.properties.chrome_button_url2
content.platforms.chrome.button2.url
https://example.com
Firefox title (not multilanguage)
preset.properties.firefox_header
content.platforms.firefox.title
"Hi there"
Firefox custom icon
preset.properties.firefox_icon
content.platforms.firefox.icon
https://example.com
Campaign code
preset.properties.campaign_code
campaignCode
"12345-67890"
Target platforms 
preset.platforms
segmentation.platforms
1 — iOS; 3 — Android; 5 — Windows Phone; 7 — OS X; 8 — Windows 8; 9 — Amazon; 10 — Safari; 11 — Chrome; 12 — Firefox; 13 - IE11; 17 - Huawei

API Reference - Previous

Presets

Next - API Reference

Device API

Last modified 18d ago

Copy link