Campaigns: Create One

Push Notification's Categories Buttons Mapping

{
  "PULEmojiLikeEmojiNeutralEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeEmojiNeutralEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULEmojiLikeEmojiNeutralEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeEmojiNeutralEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULEmojiLikeDismissEmojiNeutralEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULEmojiLikeDismissEmojiNeutralEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULEmojiLikeEmojiNeutralDismissEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULEmojiLikeEmojiNeutralDismissEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeDismissEmojiNeutralEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeDismissEmojiNeutralEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeEmojiNeutralDismissEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeEmojiNeutralDismissEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULEmojiLikeDismissEmojiNeutralDismissEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULEmojiLikeDismissEmojiNeutralDismissEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeDismissEmojiNeutralDismissEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeDismissEmojiNeutralDismissEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiNeutral",
    "EmojiDislike"
  ],
  "PULAcceptDeclineCategory": [
    "Accept",
    "Decline"
  ],
  "PULDismissAcceptDeclineCategory": [
    "Accept",
    "Decline"
  ],
  "PULAcceptDeclineReplyCategory": [
    "Accept",
    "Decline"
  ],
  "PULDismissAcceptDeclineReplyCategory": [
    "Accept",
    "Decline"
  ],
  "PULAcceptDismissDeclineCategory": [
    "Accept",
    "Decline"
  ],
  "PULAcceptDismissDeclineReplyCategory": [
    "Accept",
    "Decline"
  ],
  "PULDismissAcceptDismissDeclineCategory": [
    "Accept",
    "Decline"
  ],
  "PULDismissAcceptDismissDeclineReplyCategory": [
    "Accept",
    "Decline"
  ],
  "PULAttendingNotAttendingCategory": [
    "Attending",
    "Not Attending"
  ],
  "PULDismissAttendingNotAttendingCategory": [
    "Attending",
    "Not Attending"
  ],
  "PULAttendingNotAttendingReplyCategory": [
    "Attending",
    "Not Attending"
  ],
  "PULDismissAttendingNotAttendingReplyCategory": [
    "Attending",
    "Not Attending"
  ],
  "PULAttendingDismissNotAttendingCategory": [
    "Attending",
    "Not Attending"
  ],
  "PULAttendingDismissNotAttendingReplyCategory": [
    "Attending",
    "Not Attending"
  ],
  "PULDismissAttendingDismissNotAttendingCategory": [
    "Attending",
    "Not Attending"
  ],
  "PULDismissAttendingDismissNotAttendingReplyCategory": [
    "Attending",
    "Not Attending"
  ],
  "PULEmojiLikeEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiDislike"
  ],
  "PULEmojiLikeEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiDislike"
  ],
  "PULEmojiLikeDismissEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiDislike"
  ],
  "PULEmojiLikeDismissEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeDismissEmojiDislikeCategory": [
    "EmojiLike",
    "EmojiDislike"
  ],
  "PULDismissEmojiLikeDismissEmojiDislikeReplyCategory": [
    "EmojiLike",
    "EmojiDislike"
  ],
  "PULEmojiUpvoteEmojiDownvoteCategory": [
    "EmojiUpvote",
    "EmojiDownvote"
  ],
  "PULDismissEmojiUpvoteEmojiDownvoteCategory": [
    "EmojiUpvote",
    "EmojiDownvote"
  ],
  "PULEmojiUpvoteEmojiDownvoteReplyCategory": [
    "EmojiUpvote",
    "EmojiDownvote"
  ],
  "PULDismissEmojiUpvoteEmojiDownvoteReplyCategory": [
    "EmojiUpvote",
    "EmojiDownvote"
  ],
  "PULEmojiUpvoteDismissEmojiDownvoteCategory": [
    "EmojiUpvote",
    "EmojiDownvote"
  ],
  "PULEmojiUpvoteDismissEmojiDownvoteReplyCategory": [
    "EmojiUpvote",
    "EmojiDownvote"
  ],
  "PULDismissEmojiUpvoteDismissEmojiDownvoteCategory": [
    "EmojiUpvote",
    "EmojiDownvote"
  ],
  "PULDismissEmojiUpvoteDismissEmojiDownvoteReplyCategory": [
    "EmojiUpvote",
    "EmojiDownvote"
  ],
  "PULInterestedNotInterestedCategory": [
    "Interested",
    "Not Interested"
  ],
  "PULDismissInterestedNotInterestedCategory": [
    "Interested",
    "Not Interested"
  ],
  "PULInterestedNotInterestedReplyCategory": [
    "Interested",
    "Not Interested"
  ],
  "PULDismissInterestedNotInterestedReplyCategory": [
    "Interested",
    "Not Interested"
  ],
  "PULInterestedDismissNotInterestedCategory": [
    "Interested",
    "Not Interested"
  ],
  "PULInterestedDismissNotInterestedReplyCategory": [
    "Interested",
    "Not Interested"
  ],
  "PULDismissInterestedDismissNotInterestedCategory": [
    "Interested",
    "Not Interested"
  ],
  "PULDismissInterestedDismissNotInterestedReplyCategory": [
    "Interested",
    "Not Interested"
  ],
  "PULLikeDislikeCategory": [
    "Like",
    "Dislike"
  ],
  "PULDismissLikeDislikeCategory": [
    "Like",
    "Dislike"
  ],
  "PULLikeDislikeReplyCategory": [
    "Like",
    "Dislike"
  ],
  "PULDismissLikeDislikeReplyCategory": [
    "Like",
    "Dislike"
  ],
  "PULLikeDismissDislikeCategory": [
    "Like",
    "Dislike"
  ],
  "PULLikeDismissDislikeReplyCategory": [
    "Like",
    "Dislike"
  ],
  "PULDismissLikeDismissDislikeCategory": [
    "Like",
    "Dislike"
  ],
  "PULDismissLikeDismissDislikeReplyCategory": [
    "Like",
    "Dislike"
  ],
  "PULMoreLikeThisLessLikeThisCategory": [
    "More Like This",
    "Less Like This"
  ],
  "PULDismissMoreLikeThisLessLikeThisCategory": [
    "More Like This",
    "Less Like This"
  ],
  "PULMoreLikeThisLessLikeThisReplyCategory": [
    "More Like This",
    "Less Like This"
  ],
  "PULDismissMoreLikeThisLessLikeThisReplyCategory": [
    "More Like This",
    "Less Like This"
  ],
  "PULMoreLikeThisDismissLessLikeThisCategory": [
    "More Like This",
    "Less Like This"
  ],
  "PULMoreLikeThisDismissLessLikeThisReplyCategory": [
    "More Like This",
    "Less Like This"
  ],
  "PULDismissMoreLikeThisDismissLessLikeThisCategory": [
    "More Like This",
    "Less Like This"
  ],
  "PULDismissMoreLikeThisDismissLessLikeThisReplyCategory": [
    "More Like This",
    "Less Like This"
  ],
  "PULOpt-InOpt-OutCategory": [
    "Opt-In",
    "Opt-Out"
  ],
  "PULDismissOpt-InOpt-OutCategory": [
    "Opt-In",
    "Opt-Out"
  ],
  "PULOpt-InOpt-OutReplyCategory": [
    "Opt-In",
    "Opt-Out"
  ],
  "PULDismissOpt-InOpt-OutReplyCategory": [
    "Opt-In",
    "Opt-Out"
  ],
  "PULOpt-InDismissOpt-OutCategory": [
    "Opt-In",
    "Opt-Out"
  ],
  "PULOpt-InDismissOpt-OutReplyCategory": [
    "Opt-In",
    "Opt-Out"
  ],
  "PULDismissOpt-InDismissOpt-OutCategory": [
    "Opt-In",
    "Opt-Out"
  ],
  "PULDismissOpt-InDismissOpt-OutReplyCategory": [
    "Opt-In",
    "Opt-Out"
  ],
  "PULYesNoCategory": [
    "Yes",
    "No"
  ],
  "PULDismissYesNoCategory": [
    "Yes",
    "No"
  ],
  "PULYesNoReplyCategory": [
    "Yes",
    "No"
  ],
  "PULDismissYesNoReplyCategory": [
    "Yes",
    "No"
  ],
  "PULYesDismissNoCategory": [
    "Yes",
    "No"
  ],
  "PULYesDismissNoReplyCategory": [
    "Yes",
    "No"
  ],
  "PULDismissYesDismissNoCategory": [
    "Yes",
    "No"
  ],
  "PULDismissYesDismissNoReplyCategory": [
    "Yes",
    "No"
  ],
  "PULAddtoCalendarCategory": [
    "Add to Calendar"
  ],
  "PULDismissAddtoCalendarCategory": [
    "Add to Calendar"
  ],
  "PULAddtoCalendarReplyCategory": [
    "Add to Calendar"
  ],
  "PULDismissAddtoCalendarReplyCategory": [
    "Add to Calendar"
  ],
  "PULBookNowCategory": [
    "Book Now"
  ],
  "PULDismissBookNowCategory": [
    "Book Now"
  ],
  "PULBookNowReplyCategory": [
    "Book Now"
  ],
  "PULDismissBookNowReplyCategory": [
    "Book Now"
  ],
  "PULBuyNowCategory": [
    "Buy Now"
  ],
  "PULDismissBuyNowCategory": [
    "Buy Now"
  ],
  "PULBuyNowReplyCategory": [
    "Buy Now"
  ],
  "PULDismissBuyNowReplyCategory": [
    "Buy Now"
  ],
  "PULCheckInCategory": [
    "Check In"
  ],
  "PULDismissCheckInCategory": [
    "Check In"
  ],
  "PULCheckInReplyCategory": [
    "Check In"
  ],
  "PULDismissCheckInReplyCategory": [
    "Check In"
  ],
  "PULDownloadCategory": [
    "Download"
  ],
  "PULDismissDownloadCategory": [
    "Download"
  ],
  "PULDownloadReplyCategory": [
    "Download"
  ],
  "PULDismissDownloadReplyCategory": [
    "Download"
  ],
  "PULFindOutMoreCategory": [
    "Find Out More"
  ],
  "PULDismissFindOutMoreCategory": [
    "Find Out More"
  ],
  "PULFindOutMoreReplyCategory": [
    "Find Out More"
  ],
  "PULDismissFindOutMoreReplyCategory": [
    "Find Out More"
  ],
  "PULFollowCategory": [
    "Follow"
  ],
  "PULDismissFollowCategory": [
    "Follow"
  ],
  "PULFollowReplyCategory": [
    "Follow"
  ],
  "PULDismissFollowReplyCategory": [
    "Follow"
  ],
  "PULGetCouponCategory": [
    "Get Coupon"
  ],
  "PULDismissGetCouponCategory": [
    "Get Coupon"
  ],
  "PULGetCouponReplyCategory": [
    "Get Coupon"
  ],
  "PULDismissGetCouponReplyCategory": [
    "Get Coupon"
  ],
  "PULGetDirectionsCategory": [
    "Get Directions"
  ],
  "PULDismissGetDirectionsCategory": [
    "Get Directions"
  ],
  "PULGetDirectionsReplyCategory": [
    "Get Directions"
  ],
  "PULDismissGetDirectionsReplyCategory": [
    "Get Directions"
  ],
  "PULLearnMoreCategory": [
    "Learn More"
  ],
  "PULDismissLearnMoreCategory": [
    "Learn More"
  ],
  "PULLearnMoreReplyCategory": [
    "Learn More"
  ],
  "PULDismissLearnMoreReplyCategory": [
    "Learn More"
  ],
  "PULMoreInfoCategory": [
    "More Info"
  ],
  "PULDismissMoreInfoCategory": [
    "More Info"
  ],
  "PULMoreInfoReplyCategory": [
    "More Info"
  ],
  "PULDismissMoreInfoReplyCategory": [
    "More Info"
  ],
  "PULOrderNowCategory": [
    "Order Now"
  ],
  "PULDismissOrderNowCategory": [
    "Order Now"
  ],
  "PULOrderNowReplyCategory": [
    "Order Now"
  ],
  "PULDismissOrderNowReplyCategory": [
    "Order Now"
  ],
  "PULRateNowCategory": [
    "Rate Now"
  ],
  "PULDismissRateNowCategory": [
    "Rate Now"
  ],
  "PULRateNowReplyCategory": [
    "Rate Now"
  ],
  "PULDismissRateNowReplyCategory": [
    "Rate Now"
  ],
  "PULShopNowCategory": [
    "Shop Now"
  ],
  "PULDismissShopNowCategory": [
    "Shop Now"
  ],
  "PULShopNowReplyCategory": [
    "Shop Now"
  ],
  "PULDismissShopNowReplyCategory": [
    "Shop Now"
  ],
  "PULSignUpCategory": [
    "Sign Up"
  ],
  "PULDismissSignUpCategory": [
    "Sign Up"
  ],
  "PULSignUpReplyCategory": [
    "Sign Up"
  ],
  "PULDismissSignUpReplyCategory": [
    "Sign Up"
  ],
  "PULUpdateCategory": [
    "Update"
  ],
  "PULDismissUpdateCategory": [
    "Update"
  ],
  "PULUpdateReplyCategory": [
    "Update"
  ],
  "PULDismissUpdateReplyCategory": [
    "Update"
  ],
  "PULUpgradeNowCategory": [
    "Upgrade Now"
  ],
  "PULDismissUpgradeNowCategory": [
    "Upgrade Now"
  ],
  "PULUpgradeNowReplyCategory": [
    "Upgrade Now"
  ],
  "PULDismissUpgradeNowReplyCategory": [
    "Upgrade Now"
  ],
  "PULViewCouponCategory": [
    "View Coupon"
  ],
  "PULDismissViewCouponCategory": [
    "View Coupon"
  ],
  "PULViewCouponReplyCategory": [
    "View Coupon"
  ],
  "PULDismissViewCouponReplyCategory": [
    "View Coupon"
  ],
  "PULViewMapCategory": [
    "View Map"
  ],
  "PULDismissViewMapCategory": [
    "View Map"
  ],
  "PULViewMapReplyCategory": [
    "View Map"
  ],
  "PULDismissViewMapReplyCategory": [
    "View Map"
  ],
  "PULViewMenuCategory": [
    "View Menu"
  ],
  "PULDismissViewMenuCategory": [
    "View Menu"
  ],
  "PULViewMenuReplyCategory": [
    "View Menu"
  ],
  "PULDismissViewMenuReplyCategory": [
    "View Menu"
  ],
  "PULViewMoreCategory": [
    "View More"
  ],
  "PULDismissViewMoreCategory": [
    "View More"
  ],
  "PULViewMoreReplyCategory": [
    "View More"
  ],
  "PULDismissViewMoreReplyCategory": [
    "View More"
  ],
  "PULViewOfferCategory": [
    "View Offer"
  ],
  "PULDismissViewOfferCategory": [
    "View Offer"
  ],
  "PULViewOfferReplyCategory": [
    "View Offer"
  ],
  "PULDismissViewOfferReplyCategory": [
    "View Offer"
  ],
  "PULDefaultCategory": [

  ]
}

Time Zones Names

[
  "Africa/Algiers",
  "Africa/Cairo",
  "Africa/Casablanca",
  "Africa/Harare",
  "Africa/Johannesburg",
  "Africa/Monrovia",
  "Africa/Nairobi",
  "America/Argentina/Buenos_Aires",
  "America/Bogota",
  "America/Caracas",
  "America/Chicago",
  "America/Chihuahua",
  "America/Denver",
  "America/Godthab",
  "America/Guatemala",
  "America/Guyana",
  "America/Halifax",
  "America/Indiana/Indianapolis",
  "America/Juneau",
  "America/La_Paz",
  "America/Lima",
  "America/Los_Angeles",
  "America/Mazatlan",
  "America/Mexico_City",
  "America/Monterrey",
  "America/Montevideo",
  "America/New_York",
  "America/Phoenix",
  "America/Regina",
  "America/Santiago",
  "America/Sao_Paulo",
  "America/St_Johns",
  "America/Tijuana",
  "Asia/Almaty",
  "Asia/Baghdad",
  "Asia/Baku",
  "Asia/Bangkok",
  "Asia/Chongqing",
  "Asia/Colombo",
  "Asia/Dhaka",
  "Asia/Hong_Kong",
  "Asia/Irkutsk",
  "Asia/Jakarta",
  "Asia/Jerusalem",
  "Asia/Kabul",
  "Asia/Kamchatka",
  "Asia/Karachi",
  "Asia/Kathmandu",
  "Asia/Kolkata",
  "Asia/Krasnoyarsk",
  "Asia/Kuala_Lumpur",
  "Asia/Kuwait",
  "Asia/Magadan",
  "Asia/Muscat",
  "Asia/Novosibirsk",
  "Asia/Rangoon",
  "Asia/Riyadh",
  "Asia/Seoul",
  "Asia/Shanghai",
  "Asia/Singapore",
  "Asia/Taipei",
  "Asia/Tashkent",
  "Asia/Tbilisi",
  "Asia/Tehran",
  "Asia/Tokyo",
  "Asia/Ulaanbaatar",
  "Asia/Urumqi",
  "Asia/Vladivostok",
  "Asia/Yakutsk",
  "Asia/Yekaterinburg",
  "Asia/Yerevan",
  "Atlantic/Azores",
  "Atlantic/Cape_Verde",
  "Atlantic/South_Georgia",
  "Australia/Adelaide",
  "Australia/Brisbane",
  "Australia/Darwin",
  "Australia/Hobart",
  "Australia/Melbourne",
  "Australia/Perth",
  "Australia/Sydney",
  "Etc/UTC",
  "Europe/Amsterdam",
  "Europe/Athens",
  "Europe/Belgrade",
  "Europe/Berlin",
  "Europe/Bratislava",
  "Europe/Brussels",
  "Europe/Bucharest",
  "Europe/Budapest",
  "Europe/Copenhagen",
  "Europe/Dublin",
  "Europe/Helsinki",
  "Europe/Istanbul",
  "Europe/Kiev",
  "Europe/Lisbon",
  "Europe/Ljubljana",
  "Europe/London",
  "Europe/Madrid",
  "Europe/Minsk",
  "Europe/Moscow",
  "Europe/Paris",
  "Europe/Prague",
  "Europe/Riga",
  "Europe/Rome",
  "Europe/Sarajevo",
  "Europe/Skopje",
  "Europe/Sofia",
  "Europe/Stockholm",
  "Europe/Tallinn",
  "Europe/Vienna",
  "Europe/Vilnius",
  "Europe/Warsaw",
  "Europe/Zagreb",
  "Pacific/Apia",
  "Pacific/Auckland",
  "Pacific/Chatham",
  "Pacific/Fakaofo",
  "Pacific/Fiji",
  "Pacific/Guadalcanal",
  "Pacific/Guam",
  "Pacific/Honolulu",
  "Pacific/Majuro",
  "Pacific/Midway",
  "Pacific/Noumea",
  "Pacific/Pago_Pago",
  "Pacific/Port_Moresby",
  "Pacific/Tongatapu"
]

Deeplink and url personalization

Like the content of cards, in - app notifications, and push notifications deeplinks and urls can also be personalized. Deeplink and url templates can use values of first name, last name, full name, as well as data stored under any custom tag sent to Pulsate.

This feature is useful for personalization of content among recipients of the same campaign. For example if a travel app sets a campaign sent to users who abandoned their orders each user can receive a link to a trip they were interested in, even though there is only one campaign sent.

It can also be used to track conversions across many systems. One can add a tracking id to users and then track individual visitors, even when they enter the webpage directly from the app.

# Urls
{
	# First Name
  "destination_url": "https://www.example.com?q={{firstName}}"
}

{
	# Last Name
  "destination_url": "https://www.example.com?q={{lastName}}"
}

{
	# Full Name
  "destination_url": "https://www.example.com?q={{fullName}}"
}
 
{
	# Custom Tag named MyCustomTag
  "destination_url": "https://www.example.com?q={{MyCustomTag}}"
}

{
	# Custom Tag named MyCustomTag with fallback value
  "destination_url": "https://www.example.com?q={{ MyCustomTag | default: 'default' }}"
}
# Urls
{
	# First Name
  "destination_url": "myapp://deeplink?q={{firstName}}"
}

{
	# Last Name
  "destination_url": "myapp://deeplink?q={{lastName}}"
}

{
	# Full Name
  "destination_url": "myapp://deeplink?q={{fullName}}"
}
 
{
	# Custom Tag named MyCustomTag
  "destination_url": "myapp://deeplink?q={{MyCustomTag}}"
}

{
	# Custom Tag named MyCustomTag with fallback value
  "destination_url": "myapp://deeplink?q={{ MyCustomTag | default: 'default' }}"
}

🚧

Push Variants and Push Notification

A campaign payload can include either push_notification or push_variants fields, but not both.

πŸ“˜

Dispatch Rate and Control Group

A campaign can have both dispatch_rate and control_group. When a campaign is being sent a dispatch rate is used to determine which users get the campaign, then some of the users from this narrower set are assigned to the control group.

Language
Authorization
Header
Click Try It! to start a request and see the response here!