{"_id":"5804f32dd1b3990f002089eb","project":"54aa7f773b56130b0056c86e","parentDoc":null,"githubsync":"","user":"57f76aab760f3a1700219e15","version":{"_id":"55781fe25129590d003ff4f7","project":"54aa7f773b56130b0056c86e","forked_from":"54aa7f773b56130b0056c871","__v":6,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z","categories":["55781fe35129590d003ff4f8","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","55781fe35129590d003ff4fb","55781fe35129590d003ff4fc","55781fe35129590d003ff4fd","55781fe35129590d003ff4fe","564bbc7e8841060d00abb2ee","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","582318b23b961a0f009516a1","594a848c9f4771001a43c959"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Developers","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"564bbc7e8841060d00abb2ee","__v":10,"pages":["564bbf454bf5c80d0020901e","564bc1b08b1c5521002bb914","564c387b9baa330d00faa622","564c3a7b61008d17006ffa3a","564c3e4083b72c2b00b36fb6","564c431b61008d17006ffa46","564c4bc9b9cdb41700a0eae7","564c4e955f9d102b00fc3b4a","564c5f32c241881700d85981","564c68a93eb8f81700838a25"],"project":"54aa7f773b56130b0056c86e","version":"55781fe25129590d003ff4f7","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-17T23:47:10.058Z","from_sync":false,"order":1,"slug":"pulsate-cms-api","title":"Pulsate CMS API"},"__v":28,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-17T15:50:05.320Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"code":"{\n  \"end_at\": null,\n  \"hidden\": false,\n  \"hidden_at\": null,\n  \"name\": \"API Try | Simple Push (rich) Segment/Geofence Campaign\",\n  \"start_at\": \"2016-10-27T12:07:27+00:00\",\n  \"type\": \"PushNotificationCampaign\",\n  \"id\": \"5811ee506b6200225a1a0100\",\n  \"subscriptions_count\": 0,\n  \"state\": \"initial\"\n}","language":"json","status":201,"name":"Created (example)"}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"code":"# Before\n# set APP_ID, MY_ADMIN_API_TOKEN\n# replace values in \"{{}}\" with real ones\n\ncurl -X POST \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/campaigns/\" \\\n-H \"Authorization: Token token=\\\"$MY_ADMIN_API_TOKEN\\\"\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"type\": \"PushNotificationCampaign\",\n  \"delivery\": \"current\",\n  \"name\": \"{{currentCampaignName}}\",\n  \"segment_ids\": [\"{{defaultSegment}}\"],\n  \"goals\": [\n    {\n      \"event_kind\": \"open_app\",\n      \"expiry_time_unit\": \"hours\",\n      \"expiry_time_value\": 3,\n      \"primary\": true\n    },\n    {\n      \"event_identifier\": \"{{defaultInAppEvent}}\",\n      \"event_kind\": \"in_app_event\",\n      \"expiry_time_unit\": \"days\",\n      \"expiry_time_value\": 5,\n      \"primary\": false\n    }\n  ],\n  \"push_notification\": {\n    \"destination_type\": \"url\",\n    \"destination_url\": \"http://www.google.pl\",\n    \"body_template\": \"{{currentCampaignName}}\",\n    \"subtitle_template\": \"(tap or Accept == Google)\",\n    \"title_template\": \"Hi {{first_name | default: 'dude'}}!\",\n    \"category\": \"PULAcceptDeclineCategory\",\n    \"buttons\": [\n      {\n        \"label\": \"Accept\",\n        \"destination_type\": \"url\",\n        \"destination_url\": \"http://www.google.pl\"\n      },\n      {\n        \"label\": \"Decline\",\n        \"destination_type\": \"openapp\",\n        \"in_app_events\": [\"elo\", \"yelo\"]\n      }\n    ]\n  }\n}'","language":"shell","name":"Simple Push (rich) Segment Campaign"},{"name":"Simple Push (rich) Segment/Geofence Campaign","code":"# Before\n# set BASE_URL, APP_ID, YOUR_TOKEN\n# replace values in \"{{}}\" with real ones\n\ncurl -X POST \"$BASE_URL/api/v1/apps/$APP_ID/campaigns/\" \\\n-H \"Authorization: Token token=\\\"$YOUR_TOKEN\\\"\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"type\": \"PushNotificationCampaign\",\n  \"delivery\": \"current\",\n  \"name\": \"{{currentCampaignName}}\",\n  \"segment_ids\": [\"{{defaultSegment}}\"],\n  \"geofence_ids\": [\"{{defaultGeofence}}\"],\n  \"goals\": [\n    {\n      \"event_kind\": \"open_app\",\n      \"expiry_time_unit\": \"hours\",\n      \"expiry_time_value\": 3,\n      \"primary\": true\n    },\n    {\n      \"event_identifier\": \"{{defaultInAppEvent}}\",\n      \"event_kind\": \"in_app_event\",\n      \"expiry_time_unit\": \"days\",\n      \"expiry_time_value\": 5,\n      \"primary\": false\n    }\n  ],\n  \"push_notification\": {\n    \"destination_type\": \"url\",\n    \"destination_url\": \"http://www.google.pl\",\n    \"body_template\": \"{{currentCampaignName}}\",\n    \"subtitle_template\": \"(tap or Accept == Google)\",\n    \"title_template\": \"Hi {{first_name | default: 'dude'}}!\",\n    \"category\": \"PULAcceptDeclineCategory\",\n    \"buttons\": [\n      {\n        \"label\": \"Accept\",\n        \"destination_type\": \"url\",\n        \"destination_url\": \"http://www.google.pl\"\n      },\n      {\n        \"label\": \"Decline\",\n        \"destination_type\": \"openapp\",\n        \"in_app_events\": [\"elo\", \"yelo\"]\n      }\n    ]\n  }\n}'","language":"shell"},{"language":"shell","name":"Card Push (basic) Segment Campaign","code":"# Before\n# set BASE_URL, APP_ID, YOUR_TOKEN\n# replace values in \"{{}}\" with real ones\n\ncurl -X POST \"$BASE_URL/api/v1/apps/$APP_ID/campaigns/\" \\\n-H \"Authorization: Token token=\\\"$YOUR_TOKEN\\\"\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"type\": \"CardPushNotificationCampaign\",\n  \"allow_reply\": true,\n  \"delivery\": \"current\",\n  \"name\": \"{{currentCampaignName}}\",\n  \"segment_ids\": [\"{{defaultSegment}}\"],\n  \"goals\": [\n    {\n      \"event_kind\": \"open_app\",\n      \"expiry_time_unit\": \"hours\",\n      \"expiry_time_value\": 3,\n      \"primary\": true\n    },\n    {\n      \"event_identifier\": \"{{defaultInAppEvent}}\",\n      \"event_kind\": \"in_app_event\",\n      \"expiry_time_unit\": \"days\",\n      \"expiry_time_value\": 5,\n      \"primary\": false\n    }\n  ],\n  \"push_notification\": {\n    \"body_template\": \"{{currentCampaignName}}\"\n  },\n  \"card\": {\n    \"front_parts\": {\n      \"headline\": {\n        \"text\": \"API Try\"\n      },\n      \"call_to_action\": {\n        \"button\": {\n          \"label\": \"Card Back\",\n          \"destination_type\": \"card_back\",\n          \"in_app_events\": [\"CTAInAppEvent1\", \"CTAInAppEvent2\"]\n        }\n      }\n    },\n    \"back_parts\": {\n      \"headline\": {\n        \"text\": \"API Try (back)\"\n      },\n      \"call_to_action\": {\n        \"button\": {\n          \"label\": \"Thaiboxing\",\n          \"destination_type\": \"url\",\n          \"destination_url\": \"http://www.thaiboxing.pl\",\n          \"in_app_events\": [\"BackCTAClickedURL\"]\n        },\n        \"alternative_button\": {\n          \"label\": \"Dismiss\",\n          \"destination_type\": \"dismiss\",\n          \"in_app_events\": [\"BackCTAClickedDismiss\"]\n        }\n      }\n    }\n  }\n}'"},{"code":"# Before\n# set BASE_URL, APP_ID, YOUR_TOKEN\n# replace values in \"{{}}\" with real ones\n\ncurl -X POST \"$BASE_URL/api/v1/apps/$APP_ID/campaigns/\" \\\n-H \"Authorization: Token token=\\\"$YOUR_TOKEN\\\"\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"type\": \"CardPushNotificationCampaign\",\n  \"allow_reply\": true,\n  \"delivery\": \"current\",\n  \"name\": \"{{currentCampaignName}}\",\n  \"segment_ids\": [\"{{defaultSegment}}\"],\n  \"geofence_ids\": [\"{{defaultGeofence}}\"],\n  \"goals\": [\n    {\n      \"event_kind\": \"open_app\",\n      \"expiry_time_unit\": \"hours\",\n      \"expiry_time_value\": 3,\n      \"primary\": true\n    },\n    {\n      \"event_identifier\": \"{{defaultInAppEvent}}\",\n      \"event_kind\": \"in_app_event\",\n      \"expiry_time_unit\": \"days\",\n      \"expiry_time_value\": 5,\n      \"primary\": false\n    }\n  ],\n  \"push_notification\": {\n    \"body_template\": \"{{currentCampaignName}}\",\n    \"subtitle_template\": \"(Accept == Google)\",\n    \"title_template\": \"Hi {{first_name | default: 'dude'}}!\",\n    \"category\": \"PULAcceptDeclineCategory\",\n    \"buttons\": [\n      {\n        \"label\": \"Accept\",\n        \"destination_type\": \"url\",\n        \"destination_url\": \"http://www.google.pl\"\n      },\n      {\n        \"label\": \"Decline\",\n        \"destination_type\": \"openapp\",\n        \"in_app_events\": [\"elo\", \"yelo\"]\n      }\n    ]\n  },\n  \"card\": {\n    \"front_parts\": {\n      \"headline\": {\n        \"text\": \"API Try\"\n      },\n      \"call_to_action\": {\n        \"button\": {\n          \"label\": \"Card Back\",\n          \"destination_type\": \"card_back\",\n          \"in_app_events\": [\"CTAInAppEvent1\", \"CTAInAppEvent2\"]\n        }\n      }\n    },\n    \"back_parts\": {\n      \"headline\": {\n        \"text\": \"API Try (back)\"\n      },\n      \"call_to_action\": {\n        \"button\": {\n          \"label\": \"Thaiboxing\",\n          \"destination_type\": \"url\",\n          \"destination_url\": \"http://www.thaiboxing.pl\",\n          \"in_app_events\": [\"BackCTAClickedURL\"]\n        },\n        \"alternative_button\": {\n          \"label\": \"Dismiss\",\n          \"destination_type\": \"dismiss\",\n          \"in_app_events\": [\"BackCTAClickedDismiss\"]\n        }\n      }\n    }\n  }\n}'","language":"shell","name":"Card Push (rich) Segment/Geofence Campaign"},{"code":"# Before\n# set APP_ID, MY_ADMIN_API_TOKEN\n# replace values in \"{{}}\" with real ones\n\ncurl -X POST \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/campaigns/\" \\\n-H \"Authorization: Token token=\\\"$MY_ADMIN_API_TOKEN\\\"\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"type\": \"PushNotificationCampaign\",\n  \"delivery\": \"current\",\n  \"dispatch_rate\": 85,\n  \"name\": \"{{currentCampaignName}}\",\n  \"segment_ids\": [\"{{defaultSegment}}\"],\n  \"goals\": [\n    {\n      \"event_kind\": \"open_app\",\n      \"expiry_time_unit\": \"hours\",\n      \"expiry_time_value\": 3,\n      \"primary\": true\n    },\n    {\n      \"event_identifier\": \"{{defaultInAppEvent}}\",\n      \"event_kind\": \"in_app_event\",\n      \"expiry_time_unit\": \"days\",\n      \"expiry_time_value\": 5,\n      \"primary\": false\n    }\n  ],\n  \"push_variants\": [\n    {\n      \"destination_type\": \"url\",\n      \"destination_url\": \"http://www.google.pl\",\n      \"body_template\": \"{{currentCampaignName}}\",\n      \"subtitle_template\": \"(tap or Accept == Google)\",\n      \"title_template\": \"Hi {{first_name | default: 'dude'}}!\",\n      \"category\": \"PULAcceptDeclineCategory\",\n      \"buttons\": [\n        {\n          \"label\": \"Accept\",\n          \"destination_type\": \"url\",\n          \"destination_url\": \"http://www.google.pl\"\n        },\n        {\n          \"label\": \"Decline\",\n          \"destination_type\": \"openapp\",\n          \"in_app_events\": [\"elo\", \"yelo\"]\n        }\n      ]\n    },\n    { \"body_template\": \"{{currentCampaignName}}\" }\n  ]\n}'","language":"shell","name":"Simple Push A/B Split Testing Campaign"},{"code":"# Before\n# set BASE_URL, APP_ID, YOUR_TOKEN\n# replace values in \"{{}}\" with real ones\n\ncurl -X POST \"$BASE_URL/api/v1/apps/$APP_ID/campaigns/\" \\\n-H \"Authorization: Token token=\\\"$YOUR_TOKEN\\\"\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"type\": \"CardPushNotificationCampaign\",\n  \"allow_reply\": true,\n  \"delivery\": \"current\",\n  \"name\": \"{{currentCampaignName}}\",\n  \"segment_ids\": [\"{{defaultSegment}}\"],\n  \"goals\": [\n    {\n      \"event_kind\": \"open_app\",\n      \"expiry_time_unit\": \"hours\",\n      \"expiry_time_value\": 3,\n      \"primary\": true\n    },\n    {\n      \"event_identifier\": \"{{defaultInAppEvent}}\",\n      \"event_kind\": \"in_app_event\",\n      \"expiry_time_unit\": \"days\",\n      \"expiry_time_value\": 5,\n      \"primary\": false\n    }\n  ],\n  \"push_variants\": [\n    {\n      \"body_template\": \"{{currentCampaignName}}\"\n    },\n    {\n      \"body_template\": \"{{currentCampaignName}}\",\n      \"subtitle_template\": \"(Accept == Google)\",\n      \"title_template\": \"Hi {{first_name | default: 'dude'}}!\",\n      \"category\": \"PULAcceptDeclineCategory\",\n      \"buttons\": [\n        {\n          \"label\": \"Accept\",\n          \"destination_type\": \"url\",\n          \"destination_url\": \"http://www.google.pl\"\n        },\n        {\n          \"label\": \"Decline\",\n          \"destination_type\": \"openapp\",\n          \"in_app_events\": [\"elo\", \"yelo\"]\n        }\n      ]\n    }\n  ],\n  \"card\": {\n    \"front_parts\": {\n      \"headline\": {\n        \"text\": \"API Try\"\n      },\n      \"call_to_action\": {\n        \"button\": {\n          \"label\": \"Card Back\",\n          \"destination_type\": \"card_back\",\n          \"in_app_events\": [\"CTAInAppEvent1\", \"CTAInAppEvent2\"]\n        }\n      }\n    },\n    \"back_parts\": {\n      \"headline\": {\n        \"text\": \"API Try (back)\"\n      },\n      \"call_to_action\": {\n        \"button\": {\n          \"label\": \"Thaiboxing\",\n          \"destination_type\": \"url\",\n          \"destination_url\": \"http://www.thaiboxing.pl\",\n          \"in_app_events\": [\"BackCTAClickedURL\"]\n        },\n        \"alternative_button\": {\n          \"label\": \"Dismiss\",\n          \"destination_type\": \"dismiss\",\n          \"in_app_events\": [\"BackCTAClickedDismiss\"]\n        }\n      }\n    }\n  }\n}'","language":"shell","name":"Card Push A/B Split Testing Campaign"}]},"auth":"required","params":[{"_id":"57ff815f8e087d0e000303f4","ref":"","in":"path","required":true,"desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","default":"","type":"string","name":"app_id"},{"_id":"5804f4641642890f00803650","ref":"","in":"body","required":false,"desc":"Allow users to reply to this campaign. Must not be present for simple flow campaigns.","default":"null","type":"boolean","name":"allow_reply"},{"_id":"5804f509542ed60f00bb3f43","ref":"","in":"body","required":false,"desc":"The array of IDs of the beacons that will trigger the campaign delivery. Each ID must reference an existing company's beacon.","default":"null","type":"array_string","name":"beacon_ids"},{"_id":"583851a59387a52f00ed4472","ref":"","in":"body","required":false,"desc":"A set of beacon ids and their corresponding event on which campaign will trigger. Possible events: 'enter', 'exit'. If the corresponding id won't be provided, then the event will fallback to 'enter'.","default":"{ beacon_id => 'enter' }","type":"object","name":"beacon_events"},{"_id":"583c5a0c5081db2300548212","ref":"","in":"body","required":false,"desc":"Campaign goals. At least primary goal must be present.","default":"null","type":"array_object","name":"goals"},{"_id":"583c5a0c5081db2300548211","ref":"","in":"body","required":false,"desc":"Flag for the primary goal. Only one and at most one can be primary.","default":"false","type":"boolean","name":"goals[].primary"},{"_id":"583c5a0c5081db2300548210","ref":"","in":"body","required":false,"desc":"Kind of the goal. One of: [\"open_app\", \"in_app_event\"'].","default":"null","type":"string","name":"goals[].event_kind"},{"_id":"583c5a0c5081db230054820f","ref":"","in":"body","required":false,"desc":"Identifier of the event specified by \"event_kind\". When \"event_kind\" equals \"open_app\" then \"event_identifier\" must remain null. When \"event_kind\" is \"in_app_event\" then \"event_identifier\" should be In-App Events's name.","default":"null","type":"string","name":"goals[].event_identifier"},{"_id":"583c5a0c5081db230054820e","ref":"","in":"body","required":false,"desc":"Unit of the expiry time frame for the goal achievement. One of: [\"hour\", \"hours\", \"day\", \"days\"]. Defaults to \"hour\".","default":"\"hour\"","type":"string","name":"goals[].expiry_time_unit"},{"_id":"583c5a0c5081db230054820d","ref":"","in":"body","required":false,"desc":"Value of the expiry time frame for the goal achievement. Must be an integer greater than or equal to 1.","default":"1","type":"int","name":"goals[].expiry_time_value"},{"_id":"5804f6cd92398f0f00e77550","ref":"","in":"body","required":false,"desc":"The card associated with this campaign. It can be used only with following types: [CardInAppNotificationCampaign, CardInboxCampaign, CardPushNotificationCampaign].","default":"null","type":"object","name":"card"},{"_id":"5804f6cd92398f0f00e7754f","ref":"","in":"body","required":false,"desc":"Front parts of the campaign's card.","default":"null","type":"object","name":"card.front_parts"},{"_id":"5810898b8a4aed0f00d67560","ref":"","in":"body","required":false,"desc":"The personalized admin's message section. Works only with card campaigns otherwise must remain absent. Required for small \"personal\" In-App Notification.","default":"null","type":"object","name":"card.front_parts.admin_header_with_message"},{"_id":"5810898b8a4aed0f00d6755f","ref":"","in":"body","required":false,"desc":"The actual admin header's message.","default":"null","type":"string","name":"card.front_parts.admin_header_with_message.message"},{"_id":"5805d00216161c0f0077e11a","ref":"","in":"body","required":false,"desc":"Call to action section for campaign's card's front.","default":"null","type":"object","name":"card.front_parts.call_to_action"},{"_id":"5805d00216161c0f0077e119","ref":"","in":"body","required":false,"desc":"The button of card front's call to action.","default":"null","type":"object","name":"card.front_parts.call_to_action.button."},{"_id":"5805d00216161c0f0077e118","ref":"","in":"body","required":false,"desc":"Destination type of the button. One of [\"card_back\", \"deeplink\", \"url\"].","default":"\"\"","type":"string","name":"card.front_parts.call_to_action.button.destination_type"},{"_id":"5805d00216161c0f0077e117","ref":"","in":"body","required":false,"desc":"The destination url. For \"url\" destination type it must fit HTTP or HTTPS URL pattern. For \"deeplink\" it should represent one. For \"card_back\" must remain blank.  Both deeplinks and urls support variables that can be filled with personalized user data.","default":"\"\"","type":"string","name":"card.front_parts.call_to_action.button.destination_url"},{"_id":"5805d00216161c0f0077e116","ref":"","in":"body","required":false,"desc":"An array of In-App Events names triggered by clicking the button.","default":"[]","type":"array_string","name":"card.front_parts.call_to_action.button.in_app_events"},{"_id":"5805d00216161c0f0077e115","ref":"","in":"body","required":false,"desc":"The label of the call to action's button.","default":"\"View More\"","type":"string","name":"card.front_parts.call_to_action.button.label"},{"_id":"5805e549bbbcc625007e064c","ref":"","in":"body","required":false,"desc":"The headline for the campaign's card front.","default":"null","type":"object","name":"card.front_parts.headline"},{"_id":"5805e549bbbcc625007e064b","ref":"","in":"body","required":false,"desc":"Position of the headline. One of [0, 1, 2]. Note that positions of all card's elements must be unique.","default":"0","type":"int","name":"card.front_parts.headline.position"},{"_id":"5805e549bbbcc625007e064a","ref":"","in":"body","required":false,"desc":"The headline's content.","default":"null","type":"string","name":"card.front_parts.headline.text"},{"_id":"5805e549bbbcc625007e0649","ref":"","in":"body","required":false,"desc":"The image that will be rendered on the card's front.","default":"null","type":"object","name":"card.front_parts.image"},{"_id":"5805e549bbbcc625007e0648","ref":"","in":"body","required":false,"desc":"Base64 data of the image. It should include appropriate Base64 header. The acceptable formats are [gif, jpg, png]  and the maximum file size is 500kB.","default":"null","type":"string","name":"card.front_parts.image.data"},{"_id":"5805e549bbbcc625007e0647","ref":"","in":"body","required":false,"desc":"The file name of the image.","default":"null","type":"string","name":"card.front_parts.image.name"},{"_id":"5805e549bbbcc625007e0646","ref":"","in":"body","required":false,"desc":"Position of the image. One of [0, 1, 2]. Note that positions of all card's elements must be unique.","default":"1","type":"int","name":"card.front_parts.image.position"},{"_id":"5805e6e1bbbcc625007e064f","ref":"","in":"body","required":false,"desc":"The text section for the card's front.","default":"null","type":"object","name":"card.front_parts.text"},{"_id":"5805e6e1bbbcc625007e064e","ref":"","in":"body","required":false,"desc":"The actual text content.","default":"null","type":"string","name":"card.front_parts.text.text"},{"_id":"5805e6e1bbbcc625007e064d","ref":"","in":"body","required":false,"desc":"Position of the text. One of [0, 1, 2]. Note that positions of all card's elements must be unique.","default":"null","type":"string","name":"card.front_parts.text.position"},{"_id":"5805ebcb4206ab2f002a36b0","ref":"","in":"body","required":false,"desc":"Call to action section for campaign's card's back.","default":"null","type":"object","name":"card.back_parts.call_to_action"},{"_id":"5805ebcb4206ab2f002a36af","ref":"","in":"body","required":false,"desc":"The button of card back's call to action.","default":"null","type":"object","name":"card.back_parts.call_to_action.button"},{"_id":"5805ebcb4206ab2f002a36ae","ref":"","in":"body","required":false,"desc":"Destination type of the button. One of \"deeplink\", \"dismiss\", \"url\"].","default":"''","type":"string","name":"card.back_parts.call_to_action.button.destination_type"},{"_id":"5805ebcb4206ab2f002a36ad","ref":"","in":"body","required":false,"desc":"The destination url. For \"url\" destination type it must fit HTTP or HTTPS URL pattern. . For \"deeplink\" it should represent one. For \"dismiss\" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.","default":"''","type":"string","name":"card.back_parts.call_to_action.button.destination_url"},{"_id":"5805ebcb4206ab2f002a36ac","ref":"","in":"body","required":false,"desc":"An array of In-App Events names triggered by clicking the button.","default":"[]","type":"array_string","name":"card.back_parts.call_to_action.button.in_app_events"},{"_id":"5805ebcb4206ab2f002a36ab","ref":"","in":"body","required":false,"desc":"The label of the call to action's button.","default":"\"View More\"","type":"string","name":"card.back_parts.call_to_action.button.label"},{"_id":"5805f1764206ab2f002a36bf","ref":"","in":"body","required":false,"desc":"The headline for the campaign's card back.","default":"null","type":"object","name":"card.back_parts.headline"},{"_id":"5805f1764206ab2f002a36be","ref":"","in":"body","required":false,"desc":"The headline's content.","default":"null","type":"string","name":"card.back_parts.headline.text"},{"_id":"5805f1764206ab2f002a36bd","ref":"","in":"body","required":false,"desc":"Position of the headline. One of [0, 1, 2, 3]. Note that positions of all card's elements must be unique.","default":"0","type":"int","name":"card.back_parts.headline.position"},{"_id":"5805f1764206ab2f002a36bc","ref":"","in":"body","required":false,"desc":"The image that will be rendered on the card's back.","default":"null","type":"object","name":"card.back_parts.image"},{"_id":"581086d14a8aa50f00aa4cfb","ref":"","in":"body","required":false,"desc":"Base64 data of the image. It should include appropriate Base64 header. The acceptable formats are [gif, jpg, png]  and the maximum file size is 500kB.","default":"null","type":"string","name":"card.back_parts.image.data"},{"_id":"5805f1764206ab2f002a36bb","ref":"","in":"body","required":false,"desc":"The file name of the image.","default":"null","type":"string","name":"card.back_parts.image.data"},{"_id":"5805f1764206ab2f002a36b9","ref":"","in":"body","required":false,"desc":"Position of the image. One of [0, 1, 2, 3]. Note that positions of all card's elements must be unique.","default":"1","type":"int","name":"card.back_parts.image.position"},{"_id":"5805f1764206ab2f002a36b8","ref":"","in":"body","required":false,"desc":"The table to display on the card's back.","default":"null","type":"object","name":"card.back_parts.table"},{"_id":"5805f1764206ab2f002a36b7","ref":"","in":"body","required":false,"desc":"The heading to display over the table.","default":"null","type":"string","name":"card.back_parts.table.heading"},{"_id":"5805f1764206ab2f002a36b6","ref":"","in":"body","required":false,"desc":"The array of rows to display as a table's body.","default":"[]","type":"array_object","name":"card.back_parts.table.rows"},{"_id":"5805f1764206ab2f002a36b5","ref":"","in":"body","required":false,"desc":"The label of this row's value.","default":"null","type":"string","name":"card.back_parts.table.rows[].label"},{"_id":"5805f1764206ab2f002a36b4","ref":"","in":"body","required":false,"desc":"This row's value.","default":"null","type":"string","name":"card.back_parts.table.rows[].value"},{"_id":"5805f1764206ab2f002a36b3","ref":"","in":"body","required":false,"desc":"Position of the table. One of [0, 1, 2, 3]. Note that positions of all card's elements must be unique.","default":"2","type":"int","name":"card.back_parts.table.position"},{"_id":"5805f1d12188da0f00bda980","ref":"","in":"body","required":false,"desc":"The text section for the card's back.","default":"null","type":"object","name":"card.back_parts.text"},{"_id":"5805f1d12188da0f00bda97f","ref":"","in":"body","required":false,"desc":"The actual text content.","default":"null","type":"string","name":"card.back_parts.text.text"},{"_id":"5805f1d12188da0f00bda97e","ref":"","in":"body","required":false,"desc":"Position of the text. One of [0, 1, 2, 3]. Note that positions of all card's elements must be unique.","default":"3","type":"boolean","name":"card.back_parts.text.position"},{"_id":"5805f6092188da0f00bda988","ref":"","in":"body","required":false,"desc":"The control group for the campaign. Read more here: https://pulsate.readme.io/v4.0/docs/control-groups","default":"null","type":"object","name":"control_group"},{"_id":"5805f6092188da0f00bda987","ref":"","in":"body","required":false,"desc":"The percentage value of the control group. Must be between [1, 100].","default":"null","type":"int","name":"control_group.quantity"},{"_id":"5805f6092188da0f00bda986","ref":"","in":"body","required":false,"desc":"The delivery type of the campaign. Allowed values: \"current\" (deliver campaign to all users in the segment now) or \"current_future\" (deliver to all users in the segment now and that who will enter one in the future).","default":"null","type":"string","name":"delivery"},{"_id":"593fad6e331e250019c30a9e","ref":"","in":"body","required":false,"desc":"A percentage share of users eligible for the campaign to whom the campaign is delivered. Must be between 10 and 100.","default":"100","type":"int","name":"dispatch_rate"},{"_id":"5805f6092188da0f00bda985","ref":"","in":"body","required":false,"desc":"The date to stop campaign delivery. The acceptable format is: \"yyyy-mm-ddThh:nn:ss\" e.g. \"2016-05-14T13:15:00\".","default":"null","type":"string","name":"end_at"},{"_id":"5805f6092188da0f00bda984","ref":"","in":"body","required":false,"desc":"The date to remove campaign's content from user's inbox. The date to stop campaign delivery. The acceptable format is: \"yyyy-mm-ddThh:nn:ss\" e.g. \"2016-05-14T13:15:00\". Must not be passed alongside with \"expiry_time_value\".","default":"null","type":"string","name":"expiry_date"},{"_id":"5805f6092188da0f00bda983","ref":"","in":"body","required":false,"desc":"A unit of the time after which (from delivery) campaign's content will be removed from user's inbox. Ignored if \"expiry_date\" was passed.","default":"\"minutes\"","type":"string","name":"expiry_time_frame"},{"_id":"5805f6092188da0f00bda982","ref":"","in":"body","required":false,"desc":"The time after which (from delivery) campaign's content will be removed from user's inbox. Must not be used alongside with \"expiry_date\".","default":"null","type":"int","name":"expiry_time_value"},{"_id":"5805fde5ec3f3f0f003e51ce","ref":"","in":"body","required":false,"desc":"The array of IDs of Geofences that will trigger the campaign delivery. Each ID must reference an existing app's Geofence.","default":"[]","type":"array_string","name":"geofence_ids"},{"_id":"583851a59387a52f00ed4471","ref":"","in":"body","required":false,"desc":"A set of geofence ids and their corresponding event on which campaign will trigger. Possible events: 'enter', 'exit', 'dwell'. If the corresponding id won't be provided, then the event will fallback to 'enter'.","default":"{ geofence_id => 'enter' }","type":"object","name":"geofence_events"},{"_id":"586267a2ac4c7f0f00fafca0","ref":"","in":"body","required":false,"desc":"A set of geofence ids and their corresponding dwelling time in seconds on which campaign will trigger. Value has to be between 60 and 3600 (1-60 minutes). This is only set for geofence events that were set to 'dwell'.","default":"{ geofence_id => 600 }","type":"object","name":"geofence_dwelling_times"},{"_id":"5805fde5ec3f3f0f003e51cd","ref":"","in":"body","required":false,"desc":"The array of names of In-App Events that will trigger the campaign delivery.","default":"[]","type":"array_string","name":"in_app_events"},{"_id":"58107e9008d8050f00948d6b","ref":"","in":"body","required":false,"desc":"In-app notification of the campaign. Must not be used alongside with push notification.","default":"null","type":"object","name":"in_app_notification"},{"_id":"58107e9008d8050f00948d6a","ref":"","in":"body","required":false,"desc":"Large version of the in-app notification. Must not be used alongside with small.","default":"null","type":"object","name":"in_app_notification.large"},{"_id":"581080d74a8aa50f00aa4ce6","ref":"","in":"body","required":false,"desc":"Large In-App Notification's call to action.","default":"null","type":"object","name":"in_app_notification.large.call_to_action"},{"_id":"581080d74a8aa50f00aa4ce5","ref":"","in":"body","required":false,"desc":"Button of the call to action.","default":"null","type":"object","name":"in_app_notification.large.call_to_action.button"},{"_id":"581082784a8aa50f00aa4cf1","ref":"","in":"body","required":false,"desc":"The destination type of the In-App Notification's button. Must eq. \"card\" for card campaigns. For simple In-App Notification Campaigns one of [\"deeplink\", \"dismiss\", \"openfeed\", \"url\"].","default":"null","type":"string","name":"in_app_notification.large.call_to_action.button.destination_type"},{"_id":"581082784a8aa50f00aa4cf0","ref":"","in":"body","required":false,"desc":"The destination url. For \"url\" destination type it must fit HTTP or HTTPS URL pattern. For \"deeplink\" it should represent one. For any of [\"openfeed\", \"card\", \"dismiss\"] must remain blank. The destination url. For \"url\" destination type it must represent HTTP or HTTPS URL. For \"deeplink\" it should represent one. For \"dismiss\" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.","default":"null","type":"string","name":"in_app_notification.large.call_to_action.button.destination_url"},{"_id":"581082784a8aa50f00aa4cef","ref":"","in":"body","required":false,"desc":"In-App Events triggered by clicking the In-App Notification's Button.","default":"null","type":"array_string","name":"in_app_notification.large.call_to_action.button.in_app_events"},{"_id":"581082784a8aa50f00aa4cee","ref":"","in":"body","required":false,"desc":"The label for the large In-App Notification's call to action.","default":"\"View More\"","type":"string","name":"in_app_notification.large.call_to_action.button.label"},{"_id":"581080d74a8aa50f00aa4ce4","ref":"","in":"body","required":false,"desc":"The headline for the campaign's card front.","default":"null","type":"object","name":"in_app_notification.large.headline"},{"_id":"581080d74a8aa50f00aa4ce3","ref":"","in":"body","required":false,"desc":"The headline's content.","default":"null","type":"string","name":"in_app_notification.large.headline.text"},{"_id":"581080d74a8aa50f00aa4ce2","ref":"","in":"body","required":false,"desc":"Position of the headline. One of [0, 1, 2]. Note that positions of all In-App Notification's elements must be unique.","default":"0","type":"int","name":"in_app_notification.large.headline.position"},{"_id":"581080d74a8aa50f00aa4ce1","ref":"","in":"body","required":false,"desc":"The image that will be rendered on the In-App Notification.","default":"null","type":"object","name":"in_app_notification.large.image"},{"_id":"581080d74a8aa50f00aa4ce0","ref":"","in":"body","required":false,"desc":"Base64 data of the image. It should include appropriate Base64 header. The acceptable formats are [gif, jpg, png]  and the maximum file size is 500kB.","default":"null","type":"string","name":"in_app_notification.large.image.data"},{"_id":"581080d74a8aa50f00aa4cdf","ref":"","in":"body","required":false,"desc":"The file name of the image.","default":"null","type":"string","name":"in_app_notification.large.image.name"},{"_id":"581080d74a8aa50f00aa4cde","ref":"","in":"body","required":false,"desc":"Position of the image. One of [0, 1, 2]. Note that positions of all In-App Notification's elements must be unique.","default":"1","type":"int","name":"in_app_notification.large.image.position"},{"_id":"581080d74a8aa50f00aa4cdd","ref":"","in":"body","required":false,"desc":"The text section for the card's back.","default":"null","type":"object","name":"in_app_notification.large.text"},{"_id":"581080d74a8aa50f00aa4cdc","ref":"","in":"body","required":false,"desc":"The actual text content.","default":"null","type":"string","name":"in_app_notification.large.text.text"},{"_id":"581080d74a8aa50f00aa4cdb","ref":"","in":"body","required":false,"desc":"Position of the text. One of [0, 1, 2]. Note that positions of all In-App Notification's elements must be unique.","default":"2","type":"int","name":"in_app_notification.large.text.position"},{"_id":"58107e9008d8050f00948d69","ref":"","in":"body","required":false,"desc":"Small version of the in-app notification. Must not be used alongside with large.","default":"null","type":"object","name":"in_app_notification.small"},{"_id":"58107e9008d8050f00948d68","ref":"","in":"body","required":false,"desc":"Small In-App Notification's call to action.","default":"null","type":"object","name":"in_app_notification.small.call_to_action"},{"_id":"58107e9008d8050f00948d67","ref":"","in":"body","required":false,"desc":"Button of the call to action.","default":"null","type":"string","name":"in_app_notification.small.call_to_action.button"},{"_id":"58107e9008d8050f00948d66","ref":"","in":"body","required":false,"desc":"In-App Events triggered by clicking the In-App Notification's Button.","default":"null","type":"array_string","name":"in_app_notification.small.call_to_action.button.in_app_events"},{"_id":"58107e9008d8050f00948d65","ref":"","in":"body","required":false,"desc":"The destination type of the In-App Notification's button. Must eq. \"card\" for card campaigns. For simple In-App Notification Campaigns one of [\"deeplink\", \"dismiss\", \"openfeed\", \"url\"].","default":"null","type":"string","name":"in_app_notification.small.call_to_action.button.destination_type"},{"_id":"58107e9008d8050f00948d64","ref":"","in":"body","required":false,"desc":"The destination url. For \"url\" destination type it must fit HTTP or HTTPS URL pattern. For \"deeplink\" it should represent one. For any of [\"openfeed\", \"card\", \"dismiss\"] must remain blank. The destination url. For \"url\" destination type it must represent HTTP or HTTPS URL. For \"deeplink\" it should represent one. For \"dismiss\" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.","default":"null","type":"string","name":"in_app_notification.small.call_to_action.button.destination_url"},{"_id":"58107e9008d8050f00948d63","ref":"","in":"body","required":false,"desc":"Image header with message for small In-App Notification. Must not be used with \"personal\" type.","default":"null","type":"object","name":"in_app_notification.small.image_header_with_message"},{"_id":"58107e9008d8050f00948d62","ref":"","in":"body","required":false,"desc":"Position for the In-App Notification. One of [\"top\", \"bottom\"]","default":"null","type":"string","name":"in_app_notification.small.position"},{"_id":"58107e9008d8050f00948d61","ref":"","in":"body","required":false,"desc":"Type of the small In-App Notification. One of [\"corporate\", \"personal\"] If chosen \"personal\" that fits only card campaigns remember to set \"admin_header_with_message\" in \"card.front_parts\".","default":"null","type":"string","name":"in_app_notification.small.type"},{"_id":"5805fde5ec3f3f0f003e51cc","ref":"","in":"body","required":true,"desc":"The name of the campaign.","default":"null","type":"string","name":"name"},{"_id":"5805fde5ec3f3f0f003e51cb","ref":"","in":"body","required":false,"desc":"The data of the push notification that user will be sent receiving the campaign. The features tagged \"(rich media)\" may be not supported for some users. Learn more: https://pulsate.readme.io/v4.0/docs/push-notifications-rich-media","default":"null","type":"object","name":"push_notification"},{"_id":"580609feec3f3f0f003e51dd","ref":"","in":"body","required":false,"desc":"(rich media) The attachment for the push notification's alert.","default":"null","type":"object","name":"push_notification.attachment"},{"_id":"580609feec3f3f0f003e51dc","ref":"","in":"body","required":false,"desc":"The URL of the attachment. It must match HTTPS URL pattern and end with one of following extensions: [aiff, mp3, wav, m4a, jpg, gif, png, mpg, mp4, avi].","default":"null","type":"string","name":"push_notification.attachment.url"},{"_id":"580609feec3f3f0f003e51db","ref":"","in":"body","required":false,"desc":"(rich media) The action buttons of the push notification. Note that the labels are strictly related to push notification's category. See https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#push-notifications-categories-buttons-mapping for more.","default":"[]","type":"array_object","name":"push_notification.buttons"},{"_id":"580609feec3f3f0f003e51da","ref":"","in":"body","required":false,"desc":"The destination type of the button. One of [\"deeplink\", \"openapp\", \"thiscard\", \"url\"].","default":"null","type":"string","name":"push_notification.buttons[].destination_type"},{"_id":"580609feec3f3f0f003e51d9","ref":"","in":"body","required":false,"desc":"The destination url. For \"url\" destination type it must fit HTTP or HTTPS URL pattern. For \"deeplink\" it should represent one. For any of [\"openapp\", \"thiscard\"] must remain blank. The destination url. For \"url\" destination type it must represent HTTP or HTTPS URL. For \"deeplink\" it should represent one. For \"dismiss\" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.","default":"null","type":"string","name":"push_notification.buttons[].destination_url"},{"_id":"580609feec3f3f0f003e51d8","ref":"","in":"body","required":false,"desc":"An array of In-App Events names triggered by clicking the button.","default":"[]","type":"array_string","name":"push_notification.buttons[].in_app_events"},{"_id":"580609feec3f3f0f003e51d7","ref":"","in":"body","required":false,"desc":"The label of the push notification's action button.","default":"null","type":"string","name":"push_notification.buttons[].label"},{"_id":"580609feec3f3f0f003e51d6","ref":"","in":"body","required":false,"desc":"The main text of the push notification's alert.","default":"null","type":"string","name":"push_notification.body_template"},{"_id":"580609feec3f3f0f003e51d5","ref":"","in":"body","required":false,"desc":"The category of the push notification. It determines which buttons labels can be used. Default is \"PULDefaultCategory\" for notifications without action buttons. See https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#push-notifications-categories-buttons-mapping for more.","default":"\"PULDefaultCategory\"","type":"string","name":"push_notification.category"},{"_id":"5806154aec3f3f0f003e51ef","ref":"","in":"body","required":false,"desc":"The custom push notification's sound properties.","default":"null","type":"object","name":"push_notification.custom_sound"},{"_id":"5806154aec3f3f0f003e51ee","ref":"","in":"body","required":false,"desc":"The push notification's custom sound's file name. It must be available in the application.","default":"null","type":"string","name":"push_notification.custom_sound.name"},{"_id":"580a05acc831db0f007a895e","ref":"","in":"body","required":false,"desc":"Push notification's destination type. For simple push campaign (PushNotificationCampaign) one of [\"deeplink\", \"openapp\", \"url\"]. For Card campaigns one of [\"deeplink\", \"openapp\", \"thiscard\", \"url\"].","default":"null","type":"string","name":"push_notification.destination_type"},{"_id":"580a05acc831db0f007a895d","ref":"","in":"body","required":false,"desc":"The destination url. The destination url. For \"url\" destination type it must fit HTTP or HTTPS URL pattern. For \"deeplink\" it should represent one. For any of \"openapp\" must remain blank. The destination url. For \"url\" destination type it must represent HTTP or HTTPS URL. For \"deeplink\" it should represent one. For \"dismiss\" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.","default":"null","type":"string","name":"push_notification.destination_url"},{"_id":"5806154aec3f3f0f003e51ed","ref":"","in":"body","required":false,"desc":"(rich media) The subtitle to render alongside with push notification's alert.","default":"null","type":"string","name":"push_notification.subtitle_template"},{"_id":"5806154aec3f3f0f003e51ec","ref":"","in":"body","required":false,"desc":"(rich media) The title to render alongside with push notification's alert.","default":"null","type":"string","name":"push_notification.title_template"},{"_id":"593faa25331e250019c30a5a","ref":"","in":"body","required":false,"desc":"Array of push notification objects used for [A/B Split Testing](https://pulsate.readme.io/v4.0/docs/ab-split-testing)","default":"null","type":"array_object","name":"push_variants"},{"_id":"593faa25331e250019c30a59","ref":"","in":"body","required":false,"desc":"(rich media) The attachment for the push notification's alert.","default":"null","type":"object","name":"push_variants[].attachment"},{"_id":"593faa25331e250019c30a58","ref":"","in":"body","required":false,"desc":"The URL of the attachment. It must match HTTPS URL pattern and end with one of following extensions: [aiff, mp3, wav, m4a, jpg, gif, png, mpg, mp4, avi].","default":"null","type":"string","name":"push_variants[].attachment.url"},{"_id":"593faa25331e250019c30a57","ref":"","in":"body","required":false,"desc":"(rich media) The action buttons of the push notification. Note that the labels are strictly related to push notification's category. See https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#push-notifications-categories-buttons-mapping for more.","default":"[]","type":"array_object","name":"push_variants[].buttons"},{"_id":"593faa25331e250019c30a56","ref":"","in":"body","required":false,"desc":"The destination type of the button. One of [\"deeplink\", \"openapp\", \"thiscard\", \"url\"].","default":"null","type":"string","name":"push_variants[].buttons[].destination_type"},{"_id":"593faa25331e250019c30a55","ref":"","in":"body","required":false,"desc":"The destination url. For \"url\" destination type it must fit HTTP or HTTPS URL pattern. For \"deeplink\" it should represent one. For any of [\"openapp\", \"thiscard\"] must remain blank. The destination url. For \"url\" destination type it must represent HTTP or HTTPS URL. For \"deeplink\" it should represent one. For \"dismiss\" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.","default":"null","type":"string","name":"push_variants[].buttons[].destination_url"},{"_id":"593faa25331e250019c30a54","ref":"","in":"body","required":false,"desc":"An array of In-App Events names triggered by clicking the button.","default":"[]","type":"array_string","name":"push_variants[].buttons[].in_app_events"},{"_id":"593faa25331e250019c30a53","ref":"","in":"body","required":false,"desc":"The label of the push notification's action button.","default":"null","type":"string","name":"push_variants[].buttons[].label"},{"_id":"593faa25331e250019c30a52","ref":"","in":"body","required":false,"desc":"The main text of the push notification's alert.","default":"null","type":"string","name":"push_variants[].body_template"},{"_id":"593faa25331e250019c30a51","ref":"","in":"body","required":false,"desc":"The category of the push notification. It determines which buttons labels can be used. Default is \"PULDefaultCategory\" for notifications without action buttons. See https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#push-notifications-categories-buttons-mapping for more.","default":"\"PULDefaultCategory\"","type":"string","name":"push_variants[].category"},{"_id":"593faa25331e250019c30a50","ref":"","in":"body","required":false,"desc":"The custom push notification's sound properties.","default":"null","type":"object","name":"push_variants[].custom_sound"},{"_id":"593faa25331e250019c30a4f","ref":"","in":"body","required":false,"desc":"The push notification's custom sound's file name. It must be available in the application.","default":"null","type":"string","name":"push_variants[].custom_sound.name"},{"_id":"593faa25331e250019c30a4e","ref":"","in":"body","required":false,"desc":"Push notification's destination type. For simple push campaign (PushNotificationCampaign) one of [\"deeplink\", \"openapp\", \"url\"]. For Card campaigns one of [\"deeplink\", \"openapp\", \"thiscard\", \"url\"].","default":"null","type":"string","name":"push_variants[].destination_type"},{"_id":"593faa25331e250019c30a4d","ref":"","in":"body","required":false,"desc":"The destination url. The destination url. For \"url\" destination type it must fit HTTP or HTTPS URL pattern. For \"deeplink\" it should represent one. For any of \"openapp\" must remain blank. The destination url. For \"url\" destination type it must represent HTTP or HTTPS URL. For \"deeplink\" it should represent one. For \"dismiss\" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.","default":"null","type":"string","name":"push_variants[].destination_url"},{"_id":"593faa25331e250019c30a4c","ref":"","in":"body","required":false,"desc":"(rich media) The subtitle to render alongside with push notification's alert.","default":"null","type":"string","name":"push_variants[].subtitle_template"},{"_id":"593faa25331e250019c30a4b","ref":"","in":"body","required":false,"desc":"(rich media) The title to render alongside with push notification's alert.","default":"null","type":"string","name":"push_variants[].title_template"},{"_id":"5806154aec3f3f0f003e51eb","ref":"","in":"body","required":false,"desc":"The array of IDs of Segments describing users who will receive the campaign. Each ID must reference an existing app's Segment.","default":"[]","type":"array_string","name":"segment_ids"},{"_id":"5806154aec3f3f0f003e51ea","ref":"","in":"body","required":false,"desc":"The date to start campaign delivery. The acceptable format is: \"yyyy-mm-ddThh:nn:ss\" e.g. \"2016-05-14T13:15:00\".","default":"current date","type":"string","name":"start_at"},{"_id":"5806154aec3f3f0f003e51e9","ref":"","in":"body","required":false,"desc":"A unit of the time after which (from first delivery) user will be able to get the campaign again when meeting the criteria.","default":"minutes","type":"string","name":"time_frame"},{"_id":"5806154aec3f3f0f003e51e8","ref":"","in":"body","required":false,"desc":"The time after which (from first delivery) user will be able to get the campaign again when meeting the criteria.","default":"null","type":"int","name":"time_value"},{"_id":"5806154aec3f3f0f003e51e7","ref":"","in":"body","required":false,"desc":"The time windows during which the campaign will be delivered.","default":"[]","type":"array_object","name":"time_windows"},{"_id":"5806154aec3f3f0f003e51e6","ref":"","in":"body","required":false,"desc":"The beginning hour. The acceptable format is \"hh:nn\", e.g. \"16:35\".","default":"null","type":"string","name":"time_windows[].end_at"},{"_id":"5806154aec3f3f0f003e51e5","ref":"","in":"body","required":false,"desc":"The closing hour. The acceptable format is \"hh:nn\", e.g. \"16:35\".","default":"null","type":"string","name":"time_windows[].start_at"},{"_id":"5806154aec3f3f0f003e51e4","ref":"","in":"body","required":false,"desc":"A certain week day on which the campaign has to be delivered. One of: [\"Monday\", \"Tuesday\", \"Wednesday\", \"Thursday\", \"Friday\", \"Saturday\", \"Sunday\"].","default":"null","type":"string","name":"time_windows[].week_day"},{"_id":"5806154aec3f3f0f003e51e3","ref":"","in":"body","required":false,"desc":"The time zone name for better campaign delivery setup. The list of available values can be found here: https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#time-zones-names","default":"\"Etc/UTC\"","type":"string","name":"time_zone_name"},{"_id":"5806162c7f46c10f004b2fcc","ref":"","in":"body","required":false,"desc":"The campaign's type determining elements required or banned for creation. One of [\"CardPushNotificationCampaign\"].","default":"null","type":"string","name":"type"}],"url":"/apps/:app_id/campaigns"},"isReference":true,"order":18,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Push Notification's Categories Buttons Mapping\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"PULEmojiLikeEmojiNeutralEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeEmojiNeutralEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULEmojiLikeEmojiNeutralEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeEmojiNeutralEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULEmojiLikeDismissEmojiNeutralEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULEmojiLikeDismissEmojiNeutralEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULEmojiLikeEmojiNeutralDismissEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULEmojiLikeEmojiNeutralDismissEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeDismissEmojiNeutralEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeDismissEmojiNeutralEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeEmojiNeutralDismissEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeEmojiNeutralDismissEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULEmojiLikeDismissEmojiNeutralDismissEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULEmojiLikeDismissEmojiNeutralDismissEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeDismissEmojiNeutralDismissEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeDismissEmojiNeutralDismissEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiNeutral\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULAcceptDeclineCategory\\\": [\\n    \\\"Accept\\\",\\n    \\\"Decline\\\"\\n  ],\\n  \\\"PULDismissAcceptDeclineCategory\\\": [\\n    \\\"Accept\\\",\\n    \\\"Decline\\\"\\n  ],\\n  \\\"PULAcceptDeclineReplyCategory\\\": [\\n    \\\"Accept\\\",\\n    \\\"Decline\\\"\\n  ],\\n  \\\"PULDismissAcceptDeclineReplyCategory\\\": [\\n    \\\"Accept\\\",\\n    \\\"Decline\\\"\\n  ],\\n  \\\"PULAcceptDismissDeclineCategory\\\": [\\n    \\\"Accept\\\",\\n    \\\"Decline\\\"\\n  ],\\n  \\\"PULAcceptDismissDeclineReplyCategory\\\": [\\n    \\\"Accept\\\",\\n    \\\"Decline\\\"\\n  ],\\n  \\\"PULDismissAcceptDismissDeclineCategory\\\": [\\n    \\\"Accept\\\",\\n    \\\"Decline\\\"\\n  ],\\n  \\\"PULDismissAcceptDismissDeclineReplyCategory\\\": [\\n    \\\"Accept\\\",\\n    \\\"Decline\\\"\\n  ],\\n  \\\"PULAttendingNotAttendingCategory\\\": [\\n    \\\"Attending\\\",\\n    \\\"Not Attending\\\"\\n  ],\\n  \\\"PULDismissAttendingNotAttendingCategory\\\": [\\n    \\\"Attending\\\",\\n    \\\"Not Attending\\\"\\n  ],\\n  \\\"PULAttendingNotAttendingReplyCategory\\\": [\\n    \\\"Attending\\\",\\n    \\\"Not Attending\\\"\\n  ],\\n  \\\"PULDismissAttendingNotAttendingReplyCategory\\\": [\\n    \\\"Attending\\\",\\n    \\\"Not Attending\\\"\\n  ],\\n  \\\"PULAttendingDismissNotAttendingCategory\\\": [\\n    \\\"Attending\\\",\\n    \\\"Not Attending\\\"\\n  ],\\n  \\\"PULAttendingDismissNotAttendingReplyCategory\\\": [\\n    \\\"Attending\\\",\\n    \\\"Not Attending\\\"\\n  ],\\n  \\\"PULDismissAttendingDismissNotAttendingCategory\\\": [\\n    \\\"Attending\\\",\\n    \\\"Not Attending\\\"\\n  ],\\n  \\\"PULDismissAttendingDismissNotAttendingReplyCategory\\\": [\\n    \\\"Attending\\\",\\n    \\\"Not Attending\\\"\\n  ],\\n  \\\"PULEmojiLikeEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULEmojiLikeEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULEmojiLikeDismissEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULEmojiLikeDismissEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeDismissEmojiDislikeCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULDismissEmojiLikeDismissEmojiDislikeReplyCategory\\\": [\\n    \\\"EmojiLike\\\",\\n    \\\"EmojiDislike\\\"\\n  ],\\n  \\\"PULEmojiUpvoteEmojiDownvoteCategory\\\": [\\n    \\\"EmojiUpvote\\\",\\n    \\\"EmojiDownvote\\\"\\n  ],\\n  \\\"PULDismissEmojiUpvoteEmojiDownvoteCategory\\\": [\\n    \\\"EmojiUpvote\\\",\\n    \\\"EmojiDownvote\\\"\\n  ],\\n  \\\"PULEmojiUpvoteEmojiDownvoteReplyCategory\\\": [\\n    \\\"EmojiUpvote\\\",\\n    \\\"EmojiDownvote\\\"\\n  ],\\n  \\\"PULDismissEmojiUpvoteEmojiDownvoteReplyCategory\\\": [\\n    \\\"EmojiUpvote\\\",\\n    \\\"EmojiDownvote\\\"\\n  ],\\n  \\\"PULEmojiUpvoteDismissEmojiDownvoteCategory\\\": [\\n    \\\"EmojiUpvote\\\",\\n    \\\"EmojiDownvote\\\"\\n  ],\\n  \\\"PULEmojiUpvoteDismissEmojiDownvoteReplyCategory\\\": [\\n    \\\"EmojiUpvote\\\",\\n    \\\"EmojiDownvote\\\"\\n  ],\\n  \\\"PULDismissEmojiUpvoteDismissEmojiDownvoteCategory\\\": [\\n    \\\"EmojiUpvote\\\",\\n    \\\"EmojiDownvote\\\"\\n  ],\\n  \\\"PULDismissEmojiUpvoteDismissEmojiDownvoteReplyCategory\\\": [\\n    \\\"EmojiUpvote\\\",\\n    \\\"EmojiDownvote\\\"\\n  ],\\n  \\\"PULInterestedNotInterestedCategory\\\": [\\n    \\\"Interested\\\",\\n    \\\"Not Interested\\\"\\n  ],\\n  \\\"PULDismissInterestedNotInterestedCategory\\\": [\\n    \\\"Interested\\\",\\n    \\\"Not Interested\\\"\\n  ],\\n  \\\"PULInterestedNotInterestedReplyCategory\\\": [\\n    \\\"Interested\\\",\\n    \\\"Not Interested\\\"\\n  ],\\n  \\\"PULDismissInterestedNotInterestedReplyCategory\\\": [\\n    \\\"Interested\\\",\\n    \\\"Not Interested\\\"\\n  ],\\n  \\\"PULInterestedDismissNotInterestedCategory\\\": [\\n    \\\"Interested\\\",\\n    \\\"Not Interested\\\"\\n  ],\\n  \\\"PULInterestedDismissNotInterestedReplyCategory\\\": [\\n    \\\"Interested\\\",\\n    \\\"Not Interested\\\"\\n  ],\\n  \\\"PULDismissInterestedDismissNotInterestedCategory\\\": [\\n    \\\"Interested\\\",\\n    \\\"Not Interested\\\"\\n  ],\\n  \\\"PULDismissInterestedDismissNotInterestedReplyCategory\\\": [\\n    \\\"Interested\\\",\\n    \\\"Not Interested\\\"\\n  ],\\n  \\\"PULLikeDislikeCategory\\\": [\\n    \\\"Like\\\",\\n    \\\"Dislike\\\"\\n  ],\\n  \\\"PULDismissLikeDislikeCategory\\\": [\\n    \\\"Like\\\",\\n    \\\"Dislike\\\"\\n  ],\\n  \\\"PULLikeDislikeReplyCategory\\\": [\\n    \\\"Like\\\",\\n    \\\"Dislike\\\"\\n  ],\\n  \\\"PULDismissLikeDislikeReplyCategory\\\": [\\n    \\\"Like\\\",\\n    \\\"Dislike\\\"\\n  ],\\n  \\\"PULLikeDismissDislikeCategory\\\": [\\n    \\\"Like\\\",\\n    \\\"Dislike\\\"\\n  ],\\n  \\\"PULLikeDismissDislikeReplyCategory\\\": [\\n    \\\"Like\\\",\\n    \\\"Dislike\\\"\\n  ],\\n  \\\"PULDismissLikeDismissDislikeCategory\\\": [\\n    \\\"Like\\\",\\n    \\\"Dislike\\\"\\n  ],\\n  \\\"PULDismissLikeDismissDislikeReplyCategory\\\": [\\n    \\\"Like\\\",\\n    \\\"Dislike\\\"\\n  ],\\n  \\\"PULMoreLikeThisLessLikeThisCategory\\\": [\\n    \\\"More Like This\\\",\\n    \\\"Less Like This\\\"\\n  ],\\n  \\\"PULDismissMoreLikeThisLessLikeThisCategory\\\": [\\n    \\\"More Like This\\\",\\n    \\\"Less Like This\\\"\\n  ],\\n  \\\"PULMoreLikeThisLessLikeThisReplyCategory\\\": [\\n    \\\"More Like This\\\",\\n    \\\"Less Like This\\\"\\n  ],\\n  \\\"PULDismissMoreLikeThisLessLikeThisReplyCategory\\\": [\\n    \\\"More Like This\\\",\\n    \\\"Less Like This\\\"\\n  ],\\n  \\\"PULMoreLikeThisDismissLessLikeThisCategory\\\": [\\n    \\\"More Like This\\\",\\n    \\\"Less Like This\\\"\\n  ],\\n  \\\"PULMoreLikeThisDismissLessLikeThisReplyCategory\\\": [\\n    \\\"More Like This\\\",\\n    \\\"Less Like This\\\"\\n  ],\\n  \\\"PULDismissMoreLikeThisDismissLessLikeThisCategory\\\": [\\n    \\\"More Like This\\\",\\n    \\\"Less Like This\\\"\\n  ],\\n  \\\"PULDismissMoreLikeThisDismissLessLikeThisReplyCategory\\\": [\\n    \\\"More Like This\\\",\\n    \\\"Less Like This\\\"\\n  ],\\n  \\\"PULOpt-InOpt-OutCategory\\\": [\\n    \\\"Opt-In\\\",\\n    \\\"Opt-Out\\\"\\n  ],\\n  \\\"PULDismissOpt-InOpt-OutCategory\\\": [\\n    \\\"Opt-In\\\",\\n    \\\"Opt-Out\\\"\\n  ],\\n  \\\"PULOpt-InOpt-OutReplyCategory\\\": [\\n    \\\"Opt-In\\\",\\n    \\\"Opt-Out\\\"\\n  ],\\n  \\\"PULDismissOpt-InOpt-OutReplyCategory\\\": [\\n    \\\"Opt-In\\\",\\n    \\\"Opt-Out\\\"\\n  ],\\n  \\\"PULOpt-InDismissOpt-OutCategory\\\": [\\n    \\\"Opt-In\\\",\\n    \\\"Opt-Out\\\"\\n  ],\\n  \\\"PULOpt-InDismissOpt-OutReplyCategory\\\": [\\n    \\\"Opt-In\\\",\\n    \\\"Opt-Out\\\"\\n  ],\\n  \\\"PULDismissOpt-InDismissOpt-OutCategory\\\": [\\n    \\\"Opt-In\\\",\\n    \\\"Opt-Out\\\"\\n  ],\\n  \\\"PULDismissOpt-InDismissOpt-OutReplyCategory\\\": [\\n    \\\"Opt-In\\\",\\n    \\\"Opt-Out\\\"\\n  ],\\n  \\\"PULYesNoCategory\\\": [\\n    \\\"Yes\\\",\\n    \\\"No\\\"\\n  ],\\n  \\\"PULDismissYesNoCategory\\\": [\\n    \\\"Yes\\\",\\n    \\\"No\\\"\\n  ],\\n  \\\"PULYesNoReplyCategory\\\": [\\n    \\\"Yes\\\",\\n    \\\"No\\\"\\n  ],\\n  \\\"PULDismissYesNoReplyCategory\\\": [\\n    \\\"Yes\\\",\\n    \\\"No\\\"\\n  ],\\n  \\\"PULYesDismissNoCategory\\\": [\\n    \\\"Yes\\\",\\n    \\\"No\\\"\\n  ],\\n  \\\"PULYesDismissNoReplyCategory\\\": [\\n    \\\"Yes\\\",\\n    \\\"No\\\"\\n  ],\\n  \\\"PULDismissYesDismissNoCategory\\\": [\\n    \\\"Yes\\\",\\n    \\\"No\\\"\\n  ],\\n  \\\"PULDismissYesDismissNoReplyCategory\\\": [\\n    \\\"Yes\\\",\\n    \\\"No\\\"\\n  ],\\n  \\\"PULAddtoCalendarCategory\\\": [\\n    \\\"Add to Calendar\\\"\\n  ],\\n  \\\"PULDismissAddtoCalendarCategory\\\": [\\n    \\\"Add to Calendar\\\"\\n  ],\\n  \\\"PULAddtoCalendarReplyCategory\\\": [\\n    \\\"Add to Calendar\\\"\\n  ],\\n  \\\"PULDismissAddtoCalendarReplyCategory\\\": [\\n    \\\"Add to Calendar\\\"\\n  ],\\n  \\\"PULBookNowCategory\\\": [\\n    \\\"Book Now\\\"\\n  ],\\n  \\\"PULDismissBookNowCategory\\\": [\\n    \\\"Book Now\\\"\\n  ],\\n  \\\"PULBookNowReplyCategory\\\": [\\n    \\\"Book Now\\\"\\n  ],\\n  \\\"PULDismissBookNowReplyCategory\\\": [\\n    \\\"Book Now\\\"\\n  ],\\n  \\\"PULBuyNowCategory\\\": [\\n    \\\"Buy Now\\\"\\n  ],\\n  \\\"PULDismissBuyNowCategory\\\": [\\n    \\\"Buy Now\\\"\\n  ],\\n  \\\"PULBuyNowReplyCategory\\\": [\\n    \\\"Buy Now\\\"\\n  ],\\n  \\\"PULDismissBuyNowReplyCategory\\\": [\\n    \\\"Buy Now\\\"\\n  ],\\n  \\\"PULCheckInCategory\\\": [\\n    \\\"Check In\\\"\\n  ],\\n  \\\"PULDismissCheckInCategory\\\": [\\n    \\\"Check In\\\"\\n  ],\\n  \\\"PULCheckInReplyCategory\\\": [\\n    \\\"Check In\\\"\\n  ],\\n  \\\"PULDismissCheckInReplyCategory\\\": [\\n    \\\"Check In\\\"\\n  ],\\n  \\\"PULDownloadCategory\\\": [\\n    \\\"Download\\\"\\n  ],\\n  \\\"PULDismissDownloadCategory\\\": [\\n    \\\"Download\\\"\\n  ],\\n  \\\"PULDownloadReplyCategory\\\": [\\n    \\\"Download\\\"\\n  ],\\n  \\\"PULDismissDownloadReplyCategory\\\": [\\n    \\\"Download\\\"\\n  ],\\n  \\\"PULFindOutMoreCategory\\\": [\\n    \\\"Find Out More\\\"\\n  ],\\n  \\\"PULDismissFindOutMoreCategory\\\": [\\n    \\\"Find Out More\\\"\\n  ],\\n  \\\"PULFindOutMoreReplyCategory\\\": [\\n    \\\"Find Out More\\\"\\n  ],\\n  \\\"PULDismissFindOutMoreReplyCategory\\\": [\\n    \\\"Find Out More\\\"\\n  ],\\n  \\\"PULFollowCategory\\\": [\\n    \\\"Follow\\\"\\n  ],\\n  \\\"PULDismissFollowCategory\\\": [\\n    \\\"Follow\\\"\\n  ],\\n  \\\"PULFollowReplyCategory\\\": [\\n    \\\"Follow\\\"\\n  ],\\n  \\\"PULDismissFollowReplyCategory\\\": [\\n    \\\"Follow\\\"\\n  ],\\n  \\\"PULGetCouponCategory\\\": [\\n    \\\"Get Coupon\\\"\\n  ],\\n  \\\"PULDismissGetCouponCategory\\\": [\\n    \\\"Get Coupon\\\"\\n  ],\\n  \\\"PULGetCouponReplyCategory\\\": [\\n    \\\"Get Coupon\\\"\\n  ],\\n  \\\"PULDismissGetCouponReplyCategory\\\": [\\n    \\\"Get Coupon\\\"\\n  ],\\n  \\\"PULGetDirectionsCategory\\\": [\\n    \\\"Get Directions\\\"\\n  ],\\n  \\\"PULDismissGetDirectionsCategory\\\": [\\n    \\\"Get Directions\\\"\\n  ],\\n  \\\"PULGetDirectionsReplyCategory\\\": [\\n    \\\"Get Directions\\\"\\n  ],\\n  \\\"PULDismissGetDirectionsReplyCategory\\\": [\\n    \\\"Get Directions\\\"\\n  ],\\n  \\\"PULLearnMoreCategory\\\": [\\n    \\\"Learn More\\\"\\n  ],\\n  \\\"PULDismissLearnMoreCategory\\\": [\\n    \\\"Learn More\\\"\\n  ],\\n  \\\"PULLearnMoreReplyCategory\\\": [\\n    \\\"Learn More\\\"\\n  ],\\n  \\\"PULDismissLearnMoreReplyCategory\\\": [\\n    \\\"Learn More\\\"\\n  ],\\n  \\\"PULMoreInfoCategory\\\": [\\n    \\\"More Info\\\"\\n  ],\\n  \\\"PULDismissMoreInfoCategory\\\": [\\n    \\\"More Info\\\"\\n  ],\\n  \\\"PULMoreInfoReplyCategory\\\": [\\n    \\\"More Info\\\"\\n  ],\\n  \\\"PULDismissMoreInfoReplyCategory\\\": [\\n    \\\"More Info\\\"\\n  ],\\n  \\\"PULOrderNowCategory\\\": [\\n    \\\"Order Now\\\"\\n  ],\\n  \\\"PULDismissOrderNowCategory\\\": [\\n    \\\"Order Now\\\"\\n  ],\\n  \\\"PULOrderNowReplyCategory\\\": [\\n    \\\"Order Now\\\"\\n  ],\\n  \\\"PULDismissOrderNowReplyCategory\\\": [\\n    \\\"Order Now\\\"\\n  ],\\n  \\\"PULRateNowCategory\\\": [\\n    \\\"Rate Now\\\"\\n  ],\\n  \\\"PULDismissRateNowCategory\\\": [\\n    \\\"Rate Now\\\"\\n  ],\\n  \\\"PULRateNowReplyCategory\\\": [\\n    \\\"Rate Now\\\"\\n  ],\\n  \\\"PULDismissRateNowReplyCategory\\\": [\\n    \\\"Rate Now\\\"\\n  ],\\n  \\\"PULShopNowCategory\\\": [\\n    \\\"Shop Now\\\"\\n  ],\\n  \\\"PULDismissShopNowCategory\\\": [\\n    \\\"Shop Now\\\"\\n  ],\\n  \\\"PULShopNowReplyCategory\\\": [\\n    \\\"Shop Now\\\"\\n  ],\\n  \\\"PULDismissShopNowReplyCategory\\\": [\\n    \\\"Shop Now\\\"\\n  ],\\n  \\\"PULSignUpCategory\\\": [\\n    \\\"Sign Up\\\"\\n  ],\\n  \\\"PULDismissSignUpCategory\\\": [\\n    \\\"Sign Up\\\"\\n  ],\\n  \\\"PULSignUpReplyCategory\\\": [\\n    \\\"Sign Up\\\"\\n  ],\\n  \\\"PULDismissSignUpReplyCategory\\\": [\\n    \\\"Sign Up\\\"\\n  ],\\n  \\\"PULUpdateCategory\\\": [\\n    \\\"Update\\\"\\n  ],\\n  \\\"PULDismissUpdateCategory\\\": [\\n    \\\"Update\\\"\\n  ],\\n  \\\"PULUpdateReplyCategory\\\": [\\n    \\\"Update\\\"\\n  ],\\n  \\\"PULDismissUpdateReplyCategory\\\": [\\n    \\\"Update\\\"\\n  ],\\n  \\\"PULUpgradeNowCategory\\\": [\\n    \\\"Upgrade Now\\\"\\n  ],\\n  \\\"PULDismissUpgradeNowCategory\\\": [\\n    \\\"Upgrade Now\\\"\\n  ],\\n  \\\"PULUpgradeNowReplyCategory\\\": [\\n    \\\"Upgrade Now\\\"\\n  ],\\n  \\\"PULDismissUpgradeNowReplyCategory\\\": [\\n    \\\"Upgrade Now\\\"\\n  ],\\n  \\\"PULViewCouponCategory\\\": [\\n    \\\"View Coupon\\\"\\n  ],\\n  \\\"PULDismissViewCouponCategory\\\": [\\n    \\\"View Coupon\\\"\\n  ],\\n  \\\"PULViewCouponReplyCategory\\\": [\\n    \\\"View Coupon\\\"\\n  ],\\n  \\\"PULDismissViewCouponReplyCategory\\\": [\\n    \\\"View Coupon\\\"\\n  ],\\n  \\\"PULViewMapCategory\\\": [\\n    \\\"View Map\\\"\\n  ],\\n  \\\"PULDismissViewMapCategory\\\": [\\n    \\\"View Map\\\"\\n  ],\\n  \\\"PULViewMapReplyCategory\\\": [\\n    \\\"View Map\\\"\\n  ],\\n  \\\"PULDismissViewMapReplyCategory\\\": [\\n    \\\"View Map\\\"\\n  ],\\n  \\\"PULViewMenuCategory\\\": [\\n    \\\"View Menu\\\"\\n  ],\\n  \\\"PULDismissViewMenuCategory\\\": [\\n    \\\"View Menu\\\"\\n  ],\\n  \\\"PULViewMenuReplyCategory\\\": [\\n    \\\"View Menu\\\"\\n  ],\\n  \\\"PULDismissViewMenuReplyCategory\\\": [\\n    \\\"View Menu\\\"\\n  ],\\n  \\\"PULViewMoreCategory\\\": [\\n    \\\"View More\\\"\\n  ],\\n  \\\"PULDismissViewMoreCategory\\\": [\\n    \\\"View More\\\"\\n  ],\\n  \\\"PULViewMoreReplyCategory\\\": [\\n    \\\"View More\\\"\\n  ],\\n  \\\"PULDismissViewMoreReplyCategory\\\": [\\n    \\\"View More\\\"\\n  ],\\n  \\\"PULViewOfferCategory\\\": [\\n    \\\"View Offer\\\"\\n  ],\\n  \\\"PULDismissViewOfferCategory\\\": [\\n    \\\"View Offer\\\"\\n  ],\\n  \\\"PULViewOfferReplyCategory\\\": [\\n    \\\"View Offer\\\"\\n  ],\\n  \\\"PULDismissViewOfferReplyCategory\\\": [\\n    \\\"View Offer\\\"\\n  ],\\n  \\\"PULDefaultCategory\\\": [\\n\\n  ]\\n}\\n\",\n      \"language\": \"json\",\n      \"name\": \"\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Time Zones Names\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  \\\"Africa/Algiers\\\",\\n  \\\"Africa/Cairo\\\",\\n  \\\"Africa/Casablanca\\\",\\n  \\\"Africa/Harare\\\",\\n  \\\"Africa/Johannesburg\\\",\\n  \\\"Africa/Monrovia\\\",\\n  \\\"Africa/Nairobi\\\",\\n  \\\"America/Argentina/Buenos_Aires\\\",\\n  \\\"America/Bogota\\\",\\n  \\\"America/Caracas\\\",\\n  \\\"America/Chicago\\\",\\n  \\\"America/Chihuahua\\\",\\n  \\\"America/Denver\\\",\\n  \\\"America/Godthab\\\",\\n  \\\"America/Guatemala\\\",\\n  \\\"America/Guyana\\\",\\n  \\\"America/Halifax\\\",\\n  \\\"America/Indiana/Indianapolis\\\",\\n  \\\"America/Juneau\\\",\\n  \\\"America/La_Paz\\\",\\n  \\\"America/Lima\\\",\\n  \\\"America/Los_Angeles\\\",\\n  \\\"America/Mazatlan\\\",\\n  \\\"America/Mexico_City\\\",\\n  \\\"America/Monterrey\\\",\\n  \\\"America/Montevideo\\\",\\n  \\\"America/New_York\\\",\\n  \\\"America/Phoenix\\\",\\n  \\\"America/Regina\\\",\\n  \\\"America/Santiago\\\",\\n  \\\"America/Sao_Paulo\\\",\\n  \\\"America/St_Johns\\\",\\n  \\\"America/Tijuana\\\",\\n  \\\"Asia/Almaty\\\",\\n  \\\"Asia/Baghdad\\\",\\n  \\\"Asia/Baku\\\",\\n  \\\"Asia/Bangkok\\\",\\n  \\\"Asia/Chongqing\\\",\\n  \\\"Asia/Colombo\\\",\\n  \\\"Asia/Dhaka\\\",\\n  \\\"Asia/Hong_Kong\\\",\\n  \\\"Asia/Irkutsk\\\",\\n  \\\"Asia/Jakarta\\\",\\n  \\\"Asia/Jerusalem\\\",\\n  \\\"Asia/Kabul\\\",\\n  \\\"Asia/Kamchatka\\\",\\n  \\\"Asia/Karachi\\\",\\n  \\\"Asia/Kathmandu\\\",\\n  \\\"Asia/Kolkata\\\",\\n  \\\"Asia/Krasnoyarsk\\\",\\n  \\\"Asia/Kuala_Lumpur\\\",\\n  \\\"Asia/Kuwait\\\",\\n  \\\"Asia/Magadan\\\",\\n  \\\"Asia/Muscat\\\",\\n  \\\"Asia/Novosibirsk\\\",\\n  \\\"Asia/Rangoon\\\",\\n  \\\"Asia/Riyadh\\\",\\n  \\\"Asia/Seoul\\\",\\n  \\\"Asia/Shanghai\\\",\\n  \\\"Asia/Singapore\\\",\\n  \\\"Asia/Taipei\\\",\\n  \\\"Asia/Tashkent\\\",\\n  \\\"Asia/Tbilisi\\\",\\n  \\\"Asia/Tehran\\\",\\n  \\\"Asia/Tokyo\\\",\\n  \\\"Asia/Ulaanbaatar\\\",\\n  \\\"Asia/Urumqi\\\",\\n  \\\"Asia/Vladivostok\\\",\\n  \\\"Asia/Yakutsk\\\",\\n  \\\"Asia/Yekaterinburg\\\",\\n  \\\"Asia/Yerevan\\\",\\n  \\\"Atlantic/Azores\\\",\\n  \\\"Atlantic/Cape_Verde\\\",\\n  \\\"Atlantic/South_Georgia\\\",\\n  \\\"Australia/Adelaide\\\",\\n  \\\"Australia/Brisbane\\\",\\n  \\\"Australia/Darwin\\\",\\n  \\\"Australia/Hobart\\\",\\n  \\\"Australia/Melbourne\\\",\\n  \\\"Australia/Perth\\\",\\n  \\\"Australia/Sydney\\\",\\n  \\\"Etc/UTC\\\",\\n  \\\"Europe/Amsterdam\\\",\\n  \\\"Europe/Athens\\\",\\n  \\\"Europe/Belgrade\\\",\\n  \\\"Europe/Berlin\\\",\\n  \\\"Europe/Bratislava\\\",\\n  \\\"Europe/Brussels\\\",\\n  \\\"Europe/Bucharest\\\",\\n  \\\"Europe/Budapest\\\",\\n  \\\"Europe/Copenhagen\\\",\\n  \\\"Europe/Dublin\\\",\\n  \\\"Europe/Helsinki\\\",\\n  \\\"Europe/Istanbul\\\",\\n  \\\"Europe/Kiev\\\",\\n  \\\"Europe/Lisbon\\\",\\n  \\\"Europe/Ljubljana\\\",\\n  \\\"Europe/London\\\",\\n  \\\"Europe/Madrid\\\",\\n  \\\"Europe/Minsk\\\",\\n  \\\"Europe/Moscow\\\",\\n  \\\"Europe/Paris\\\",\\n  \\\"Europe/Prague\\\",\\n  \\\"Europe/Riga\\\",\\n  \\\"Europe/Rome\\\",\\n  \\\"Europe/Sarajevo\\\",\\n  \\\"Europe/Skopje\\\",\\n  \\\"Europe/Sofia\\\",\\n  \\\"Europe/Stockholm\\\",\\n  \\\"Europe/Tallinn\\\",\\n  \\\"Europe/Vienna\\\",\\n  \\\"Europe/Vilnius\\\",\\n  \\\"Europe/Warsaw\\\",\\n  \\\"Europe/Zagreb\\\",\\n  \\\"Pacific/Apia\\\",\\n  \\\"Pacific/Auckland\\\",\\n  \\\"Pacific/Chatham\\\",\\n  \\\"Pacific/Fakaofo\\\",\\n  \\\"Pacific/Fiji\\\",\\n  \\\"Pacific/Guadalcanal\\\",\\n  \\\"Pacific/Guam\\\",\\n  \\\"Pacific/Honolulu\\\",\\n  \\\"Pacific/Majuro\\\",\\n  \\\"Pacific/Midway\\\",\\n  \\\"Pacific/Noumea\\\",\\n  \\\"Pacific/Pago_Pago\\\",\\n  \\\"Pacific/Port_Moresby\\\",\\n  \\\"Pacific/Tongatapu\\\"\\n]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Deeplink and url personalization\"\n}\n[/block]\nLike 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.\n\nThis 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.\n\nIt 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.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"# Urls\\n{\\n\\t# First Name\\n  \\\"destination_url\\\": \\\"https://www.example.com?q={{firstName}}\\\"\\n}\\n\\n{\\n\\t# Last Name\\n  \\\"destination_url\\\": \\\"https://www.example.com?q={{lastName}}\\\"\\n}\\n\\n{\\n\\t# Full Name\\n  \\\"destination_url\\\": \\\"https://www.example.com?q={{fullName}}\\\"\\n}\\n \\n{\\n\\t# Custom Tag named MyCustomTag\\n  \\\"destination_url\\\": \\\"https://www.example.com?q={{MyCustomTag}}\\\"\\n}\\n\\n{\\n\\t# Custom Tag named MyCustomTag with fallback value\\n  \\\"destination_url\\\": \\\"https://www.example.com?q={{ MyCustomTag | default: 'default' }}\\\"\\n}\\n\\n\",\n      \"language\": \"json\",\n      \"name\": \"URLs\"\n    },\n    {\n      \"code\": \"# Urls\\n{\\n\\t# First Name\\n  \\\"destination_url\\\": \\\"myapp://deeplink?q={{firstName}}\\\"\\n}\\n\\n{\\n\\t# Last Name\\n  \\\"destination_url\\\": \\\"myapp://deeplink?q={{lastName}}\\\"\\n}\\n\\n{\\n\\t# Full Name\\n  \\\"destination_url\\\": \\\"myapp://deeplink?q={{fullName}}\\\"\\n}\\n \\n{\\n\\t# Custom Tag named MyCustomTag\\n  \\\"destination_url\\\": \\\"myapp://deeplink?q={{MyCustomTag}}\\\"\\n}\\n\\n{\\n\\t# Custom Tag named MyCustomTag with fallback value\\n  \\\"destination_url\\\": \\\"myapp://deeplink?q={{ MyCustomTag | default: 'default' }}\\\"\\n}\\n\",\n      \"language\": \"json\",\n      \"name\": \"Deeplinks\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Push Variants and Push Notification\",\n  \"body\": \"A campaign payload can include either *push_notification* or *push_variants* fields, but not both.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Dispatch Rate and Control Group\",\n  \"body\": \"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.\"\n}\n[/block]","excerpt":"","slug":"campaigns-create-one","type":"endpoint","title":"Campaigns: Create One"}

postCampaigns: Create One


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App ID. It can be fetched by using "Apps: Get All (Index)" or "Apps: Get One (Show)" endpoints.

Body Params

allow_reply:
booleannull
Allow users to reply to this campaign. Must not be present for simple flow campaigns.
beacon_ids:
array of stringsnull
The array of IDs of the beacons that will trigger the campaign delivery. Each ID must reference an existing company's beacon.
beacon_events:
object{ beacon_id => 'enter' }
A set of beacon ids and their corresponding event on which campaign will trigger. Possible events: 'enter', 'exit'. If the corresponding id won't be provided, then the event will fallback to 'enter'.
goals:
array of objectsnull
Campaign goals. At least primary goal must be present.
goals[].primary:
booleanfalse
Flag for the primary goal. Only one and at most one can be primary.
goals[].event_kind:
stringnull
Kind of the goal. One of: ["open_app", "in_app_event"'].
goals[].event_identifier:
stringnull
Identifier of the event specified by "event_kind". When "event_kind" equals "open_app" then "event_identifier" must remain null. When "event_kind" is "in_app_event" then "event_identifier" should be In-App Events's name.
goals[].expiry_time_unit:
string"hour"
Unit of the expiry time frame for the goal achievement. One of: ["hour", "hours", "day", "days"]. Defaults to "hour".
goals[].expiry_time_value:
integer1
Value of the expiry time frame for the goal achievement. Must be an integer greater than or equal to 1.
card:
objectnull
The card associated with this campaign. It can be used only with following types: [CardInAppNotificationCampaign, CardInboxCampaign, CardPushNotificationCampaign].
card.front_parts:
objectnull
Front parts of the campaign's card.
card.front_parts.admin_header_with_message:
objectnull
The personalized admin's message section. Works only with card campaigns otherwise must remain absent. Required for small "personal" In-App Notification.
card.front_parts.admin_header_with_message.message:
stringnull
The actual admin header's message.
card.front_parts.call_to_action:
objectnull
Call to action section for campaign's card's front.
card.front_parts.call_to_action.button:
objectnull
The button of card front's call to action.
card.front_parts.call_to_action.button.destination_type:
string""
Destination type of the button. One of ["card_back", "deeplink", "url"].
card.front_parts.call_to_action.button.destination_url:
string""
The destination url. For "url" destination type it must fit HTTP or HTTPS URL pattern. For "deeplink" it should represent one. For "card_back" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.
card.front_parts.call_to_action.button.in_app_events:
array of strings[]
An array of In-App Events names triggered by clicking the button.
card.front_parts.call_to_action.button.label:
string"View More"
The label of the call to action's button.
card.front_parts.headline:
objectnull
The headline for the campaign's card front.
card.front_parts.headline.position:
integer0
Position of the headline. One of [0, 1, 2]. Note that positions of all card's elements must be unique.
card.front_parts.headline.text:
stringnull
The headline's content.
card.front_parts.image:
objectnull
The image that will be rendered on the card's front.
card.front_parts.image.data:
stringnull
Base64 data of the image. It should include appropriate Base64 header. The acceptable formats are [gif, jpg, png] and the maximum file size is 500kB.
card.front_parts.image.name:
stringnull
The file name of the image.
card.front_parts.image.position:
integer1
Position of the image. One of [0, 1, 2]. Note that positions of all card's elements must be unique.
card.front_parts.text:
objectnull
The text section for the card's front.
card.front_parts.text.text:
stringnull
The actual text content.
card.front_parts.text.position:
stringnull
Position of the text. One of [0, 1, 2]. Note that positions of all card's elements must be unique.
card.back_parts.call_to_action:
objectnull
Call to action section for campaign's card's back.
card.back_parts.call_to_action.button:
objectnull
The button of card back's call to action.
card.back_parts.call_to_action.button.destination_type:
string''
Destination type of the button. One of "deeplink", "dismiss", "url"].
card.back_parts.call_to_action.button.destination_url:
string''
The destination url. For "url" destination type it must fit HTTP or HTTPS URL pattern. . For "deeplink" it should represent one. For "dismiss" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.
card.back_parts.call_to_action.button.in_app_events:
array of strings[]
An array of In-App Events names triggered by clicking the button.
card.back_parts.call_to_action.button.label:
string"View More"
The label of the call to action's button.
card.back_parts.headline:
objectnull
The headline for the campaign's card back.
card.back_parts.headline.text:
stringnull
The headline's content.
card.back_parts.headline.position:
integer0
Position of the headline. One of [0, 1, 2, 3]. Note that positions of all card's elements must be unique.
card.back_parts.image:
objectnull
The image that will be rendered on the card's back.
card.back_parts.image.data:
stringnull
Base64 data of the image. It should include appropriate Base64 header. The acceptable formats are [gif, jpg, png] and the maximum file size is 500kB.
card.back_parts.image.data:
stringnull
The file name of the image.
card.back_parts.image.position:
integer1
Position of the image. One of [0, 1, 2, 3]. Note that positions of all card's elements must be unique.
card.back_parts.table:
objectnull
The table to display on the card's back.
card.back_parts.table.heading:
stringnull
The heading to display over the table.
card.back_parts.table.rows:
array of objects[]
The array of rows to display as a table's body.
card.back_parts.table.rows[].label:
stringnull
The label of this row's value.
card.back_parts.table.rows[].value:
stringnull
This row's value.
card.back_parts.table.position:
integer2
Position of the table. One of [0, 1, 2, 3]. Note that positions of all card's elements must be unique.
card.back_parts.text:
objectnull
The text section for the card's back.
card.back_parts.text.text:
stringnull
The actual text content.
card.back_parts.text.position:
boolean3
Position of the text. One of [0, 1, 2, 3]. Note that positions of all card's elements must be unique.
control_group:
objectnull
The control group for the campaign. Read more here: https://pulsate.readme.io/v4.0/docs/control-groups
control_group.quantity:
integernull
The percentage value of the control group. Must be between [1, 100].
delivery:
stringnull
The delivery type of the campaign. Allowed values: "current" (deliver campaign to all users in the segment now) or "current_future" (deliver to all users in the segment now and that who will enter one in the future).
dispatch_rate:
integer100
A percentage share of users eligible for the campaign to whom the campaign is delivered. Must be between 10 and 100.
end_at:
stringnull
The date to stop campaign delivery. The acceptable format is: "yyyy-mm-ddThh:nn:ss" e.g. "2016-05-14T13:15:00".
expiry_date:
stringnull
The date to remove campaign's content from user's inbox. The date to stop campaign delivery. The acceptable format is: "yyyy-mm-ddThh:nn:ss" e.g. "2016-05-14T13:15:00". Must not be passed alongside with "expiry_time_value".
expiry_time_frame:
string"minutes"
A unit of the time after which (from delivery) campaign's content will be removed from user's inbox. Ignored if "expiry_date" was passed.
expiry_time_value:
integernull
The time after which (from delivery) campaign's content will be removed from user's inbox. Must not be used alongside with "expiry_date".
geofence_ids:
array of strings[]
The array of IDs of Geofences that will trigger the campaign delivery. Each ID must reference an existing app's Geofence.
geofence_events:
object{ geofence_id => 'enter' }
A set of geofence ids and their corresponding event on which campaign will trigger. Possible events: 'enter', 'exit', 'dwell'. If the corresponding id won't be provided, then the event will fallback to 'enter'.
geofence_dwelling_times:
object{ geofence_id => 600 }
A set of geofence ids and their corresponding dwelling time in seconds on which campaign will trigger. Value has to be between 60 and 3600 (1-60 minutes). This is only set for geofence events that were set to 'dwell'.
in_app_events:
array of strings[]
The array of names of In-App Events that will trigger the campaign delivery.
in_app_notification:
objectnull
In-app notification of the campaign. Must not be used alongside with push notification.
in_app_notification.large:
objectnull
Large version of the in-app notification. Must not be used alongside with small.
in_app_notification.large.call_to_action:
objectnull
Large In-App Notification's call to action.
in_app_notification.large.call_to_action.button:
objectnull
Button of the call to action.
in_app_notification.large.call_to_action.button.destination_type:
stringnull
The destination type of the In-App Notification's button. Must eq. "card" for card campaigns. For simple In-App Notification Campaigns one of ["deeplink", "dismiss", "openfeed", "url"].
in_app_notification.large.call_to_action.button.destination_url:
stringnull
The destination url. For "url" destination type it must fit HTTP or HTTPS URL pattern. For "deeplink" it should represent one. For any of ["openfeed", "card", "dismiss"] must remain blank. The destination url. For "url" destination type it must represent HTTP or HTTPS URL. For "deeplink" it should represent one. For "dismiss" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.
in_app_notification.large.call_to_action.button.in_app_events:
array of stringsnull
In-App Events triggered by clicking the In-App Notification's Button.
in_app_notification.large.call_to_action.button.label:
string"View More"
The label for the large In-App Notification's call to action.
in_app_notification.large.headline:
objectnull
The headline for the campaign's card front.
in_app_notification.large.headline.text:
stringnull
The headline's content.
in_app_notification.large.headline.position:
integer0
Position of the headline. One of [0, 1, 2]. Note that positions of all In-App Notification's elements must be unique.
in_app_notification.large.image:
objectnull
The image that will be rendered on the In-App Notification.
in_app_notification.large.image.data:
stringnull
Base64 data of the image. It should include appropriate Base64 header. The acceptable formats are [gif, jpg, png] and the maximum file size is 500kB.
in_app_notification.large.image.name:
stringnull
The file name of the image.
in_app_notification.large.image.position:
integer1
Position of the image. One of [0, 1, 2]. Note that positions of all In-App Notification's elements must be unique.
in_app_notification.large.text:
objectnull
The text section for the card's back.
in_app_notification.large.text.text:
stringnull
The actual text content.
in_app_notification.large.text.position:
integer2
Position of the text. One of [0, 1, 2]. Note that positions of all In-App Notification's elements must be unique.
in_app_notification.small:
objectnull
Small version of the in-app notification. Must not be used alongside with large.
in_app_notification.small.call_to_action:
objectnull
Small In-App Notification's call to action.
in_app_notification.small.call_to_action.button:
stringnull
Button of the call to action.
in_app_notification.small.call_to_action.button.in_app_events:
array of stringsnull
In-App Events triggered by clicking the In-App Notification's Button.
in_app_notification.small.call_to_action.button.destination_type:
stringnull
The destination type of the In-App Notification's button. Must eq. "card" for card campaigns. For simple In-App Notification Campaigns one of ["deeplink", "dismiss", "openfeed", "url"].
in_app_notification.small.call_to_action.button.destination_url:
stringnull
The destination url. For "url" destination type it must fit HTTP or HTTPS URL pattern. For "deeplink" it should represent one. For any of ["openfeed", "card", "dismiss"] must remain blank. The destination url. For "url" destination type it must represent HTTP or HTTPS URL. For "deeplink" it should represent one. For "dismiss" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.
in_app_notification.small.image_header_with_message:
objectnull
Image header with message for small In-App Notification. Must not be used with "personal" type.
in_app_notification.small.position:
stringnull
Position for the In-App Notification. One of ["top", "bottom"]
in_app_notification.small.type:
stringnull
Type of the small In-App Notification. One of ["corporate", "personal"] If chosen "personal" that fits only card campaigns remember to set "admin_header_with_message" in "card.front_parts".
name:
required
stringnull
The name of the campaign.
push_notification:
objectnull
The data of the push notification that user will be sent receiving the campaign. The features tagged "(rich media)" may be not supported for some users. Learn more: https://pulsate.readme.io/v4.0/docs/push-notifications-rich-media
push_notification.attachment:
objectnull
(rich media) The attachment for the push notification's alert.
push_notification.attachment.url:
stringnull
The URL of the attachment. It must match HTTPS URL pattern and end with one of following extensions: [aiff, mp3, wav, m4a, jpg, gif, png, mpg, mp4, avi].
push_notification.buttons:
array of objects[]
(rich media) The action buttons of the push notification. Note that the labels are strictly related to push notification's category. See https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#push-notifications-categories-buttons-mapping for more.
push_notification.buttons[].destination_type:
stringnull
The destination type of the button. One of ["deeplink", "openapp", "thiscard", "url"].
push_notification.buttons[].destination_url:
stringnull
The destination url. For "url" destination type it must fit HTTP or HTTPS URL pattern. For "deeplink" it should represent one. For any of ["openapp", "thiscard"] must remain blank. The destination url. For "url" destination type it must represent HTTP or HTTPS URL. For "deeplink" it should represent one. For "dismiss" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.
push_notification.buttons[].in_app_events:
array of strings[]
An array of In-App Events names triggered by clicking the button.
push_notification.buttons[].label:
stringnull
The label of the push notification's action button.
push_notification.body_template:
stringnull
The main text of the push notification's alert.
push_notification.category:
string"PULDefaultCategory"
The category of the push notification. It determines which buttons labels can be used. Default is "PULDefaultCategory" for notifications without action buttons. See https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#push-notifications-categories-buttons-mapping for more.
push_notification.custom_sound:
objectnull
The custom push notification's sound properties.
push_notification.custom_sound.name:
stringnull
The push notification's custom sound's file name. It must be available in the application.
push_notification.destination_type:
stringnull
Push notification's destination type. For simple push campaign (PushNotificationCampaign) one of ["deeplink", "openapp", "url"]. For Card campaigns one of ["deeplink", "openapp", "thiscard", "url"].
push_notification.destination_url:
stringnull
The destination url. The destination url. For "url" destination type it must fit HTTP or HTTPS URL pattern. For "deeplink" it should represent one. For any of "openapp" must remain blank. The destination url. For "url" destination type it must represent HTTP or HTTPS URL. For "deeplink" it should represent one. For "dismiss" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.
push_notification.subtitle_template:
stringnull
(rich media) The subtitle to render alongside with push notification's alert.
push_notification.title_template:
stringnull
(rich media) The title to render alongside with push notification's alert.
push_variants:
array of objectsnull
Array of push notification objects used for [A/B Split Testing](https://pulsate.readme.io/v4.0/docs/ab-split-testing)
push_variants[].attachment:
objectnull
(rich media) The attachment for the push notification's alert.
push_variants[].attachment.url:
stringnull
The URL of the attachment. It must match HTTPS URL pattern and end with one of following extensions: [aiff, mp3, wav, m4a, jpg, gif, png, mpg, mp4, avi].
push_variants[].buttons:
array of objects[]
(rich media) The action buttons of the push notification. Note that the labels are strictly related to push notification's category. See https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#push-notifications-categories-buttons-mapping for more.
push_variants[].buttons[].destination_type:
stringnull
The destination type of the button. One of ["deeplink", "openapp", "thiscard", "url"].
push_variants[].buttons[].destination_url:
stringnull
The destination url. For "url" destination type it must fit HTTP or HTTPS URL pattern. For "deeplink" it should represent one. For any of ["openapp", "thiscard"] must remain blank. The destination url. For "url" destination type it must represent HTTP or HTTPS URL. For "deeplink" it should represent one. For "dismiss" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.
push_variants[].buttons[].in_app_events:
array of strings[]
An array of In-App Events names triggered by clicking the button.
push_variants[].buttons[].label:
stringnull
The label of the push notification's action button.
push_variants[].body_template:
stringnull
The main text of the push notification's alert.
push_variants[].category:
string"PULDefaultCategory"
The category of the push notification. It determines which buttons labels can be used. Default is "PULDefaultCategory" for notifications without action buttons. See https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#push-notifications-categories-buttons-mapping for more.
push_variants[].custom_sound:
objectnull
The custom push notification's sound properties.
push_variants[].custom_sound.name:
stringnull
The push notification's custom sound's file name. It must be available in the application.
push_variants[].destination_type:
stringnull
Push notification's destination type. For simple push campaign (PushNotificationCampaign) one of ["deeplink", "openapp", "url"]. For Card campaigns one of ["deeplink", "openapp", "thiscard", "url"].
push_variants[].destination_url:
stringnull
The destination url. The destination url. For "url" destination type it must fit HTTP or HTTPS URL pattern. For "deeplink" it should represent one. For any of "openapp" must remain blank. The destination url. For "url" destination type it must represent HTTP or HTTPS URL. For "deeplink" it should represent one. For "dismiss" must remain blank. Both deeplinks and urls support variables that can be filled with personalized user data.
push_variants[].subtitle_template:
stringnull
(rich media) The subtitle to render alongside with push notification's alert.
push_variants[].title_template:
stringnull
(rich media) The title to render alongside with push notification's alert.
segment_ids:
array of strings[]
The array of IDs of Segments describing users who will receive the campaign. Each ID must reference an existing app's Segment.
start_at:
stringcurrent date
The date to start campaign delivery. The acceptable format is: "yyyy-mm-ddThh:nn:ss" e.g. "2016-05-14T13:15:00".
time_frame:
stringminutes
A unit of the time after which (from first delivery) user will be able to get the campaign again when meeting the criteria.
time_value:
integernull
The time after which (from first delivery) user will be able to get the campaign again when meeting the criteria.
time_windows:
array of objects[]
The time windows during which the campaign will be delivered.
time_windows[].end_at:
stringnull
The beginning hour. The acceptable format is "hh:nn", e.g. "16:35".
time_windows[].start_at:
stringnull
The closing hour. The acceptable format is "hh:nn", e.g. "16:35".
time_windows[].week_day:
stringnull
A certain week day on which the campaign has to be delivered. One of: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"].
time_zone_name:
string"Etc/UTC"
The time zone name for better campaign delivery setup. The list of available values can be found here: https://pulsate.readme.io/v2.0/docs/campaigns-create-one-new#time-zones-names
type:
stringnull
The campaign's type determining elements required or banned for creation. One of ["CardPushNotificationCampaign"].

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Push Notification's Categories Buttons Mapping" } [/block] [block:code] { "codes": [ { "code": "{\n \"PULEmojiLikeEmojiNeutralEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeEmojiNeutralEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULEmojiLikeEmojiNeutralEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeEmojiNeutralEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULEmojiLikeDismissEmojiNeutralEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULEmojiLikeDismissEmojiNeutralEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULEmojiLikeEmojiNeutralDismissEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULEmojiLikeEmojiNeutralDismissEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeDismissEmojiNeutralEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeDismissEmojiNeutralEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeEmojiNeutralDismissEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeEmojiNeutralDismissEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULEmojiLikeDismissEmojiNeutralDismissEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULEmojiLikeDismissEmojiNeutralDismissEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeDismissEmojiNeutralDismissEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeDismissEmojiNeutralDismissEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiNeutral\",\n \"EmojiDislike\"\n ],\n \"PULAcceptDeclineCategory\": [\n \"Accept\",\n \"Decline\"\n ],\n \"PULDismissAcceptDeclineCategory\": [\n \"Accept\",\n \"Decline\"\n ],\n \"PULAcceptDeclineReplyCategory\": [\n \"Accept\",\n \"Decline\"\n ],\n \"PULDismissAcceptDeclineReplyCategory\": [\n \"Accept\",\n \"Decline\"\n ],\n \"PULAcceptDismissDeclineCategory\": [\n \"Accept\",\n \"Decline\"\n ],\n \"PULAcceptDismissDeclineReplyCategory\": [\n \"Accept\",\n \"Decline\"\n ],\n \"PULDismissAcceptDismissDeclineCategory\": [\n \"Accept\",\n \"Decline\"\n ],\n \"PULDismissAcceptDismissDeclineReplyCategory\": [\n \"Accept\",\n \"Decline\"\n ],\n \"PULAttendingNotAttendingCategory\": [\n \"Attending\",\n \"Not Attending\"\n ],\n \"PULDismissAttendingNotAttendingCategory\": [\n \"Attending\",\n \"Not Attending\"\n ],\n \"PULAttendingNotAttendingReplyCategory\": [\n \"Attending\",\n \"Not Attending\"\n ],\n \"PULDismissAttendingNotAttendingReplyCategory\": [\n \"Attending\",\n \"Not Attending\"\n ],\n \"PULAttendingDismissNotAttendingCategory\": [\n \"Attending\",\n \"Not Attending\"\n ],\n \"PULAttendingDismissNotAttendingReplyCategory\": [\n \"Attending\",\n \"Not Attending\"\n ],\n \"PULDismissAttendingDismissNotAttendingCategory\": [\n \"Attending\",\n \"Not Attending\"\n ],\n \"PULDismissAttendingDismissNotAttendingReplyCategory\": [\n \"Attending\",\n \"Not Attending\"\n ],\n \"PULEmojiLikeEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiDislike\"\n ],\n \"PULEmojiLikeEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiDislike\"\n ],\n \"PULEmojiLikeDismissEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiDislike\"\n ],\n \"PULEmojiLikeDismissEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeDismissEmojiDislikeCategory\": [\n \"EmojiLike\",\n \"EmojiDislike\"\n ],\n \"PULDismissEmojiLikeDismissEmojiDislikeReplyCategory\": [\n \"EmojiLike\",\n \"EmojiDislike\"\n ],\n \"PULEmojiUpvoteEmojiDownvoteCategory\": [\n \"EmojiUpvote\",\n \"EmojiDownvote\"\n ],\n \"PULDismissEmojiUpvoteEmojiDownvoteCategory\": [\n \"EmojiUpvote\",\n \"EmojiDownvote\"\n ],\n \"PULEmojiUpvoteEmojiDownvoteReplyCategory\": [\n \"EmojiUpvote\",\n \"EmojiDownvote\"\n ],\n \"PULDismissEmojiUpvoteEmojiDownvoteReplyCategory\": [\n \"EmojiUpvote\",\n \"EmojiDownvote\"\n ],\n \"PULEmojiUpvoteDismissEmojiDownvoteCategory\": [\n \"EmojiUpvote\",\n \"EmojiDownvote\"\n ],\n \"PULEmojiUpvoteDismissEmojiDownvoteReplyCategory\": [\n \"EmojiUpvote\",\n \"EmojiDownvote\"\n ],\n \"PULDismissEmojiUpvoteDismissEmojiDownvoteCategory\": [\n \"EmojiUpvote\",\n \"EmojiDownvote\"\n ],\n \"PULDismissEmojiUpvoteDismissEmojiDownvoteReplyCategory\": [\n \"EmojiUpvote\",\n \"EmojiDownvote\"\n ],\n \"PULInterestedNotInterestedCategory\": [\n \"Interested\",\n \"Not Interested\"\n ],\n \"PULDismissInterestedNotInterestedCategory\": [\n \"Interested\",\n \"Not Interested\"\n ],\n \"PULInterestedNotInterestedReplyCategory\": [\n \"Interested\",\n \"Not Interested\"\n ],\n \"PULDismissInterestedNotInterestedReplyCategory\": [\n \"Interested\",\n \"Not Interested\"\n ],\n \"PULInterestedDismissNotInterestedCategory\": [\n \"Interested\",\n \"Not Interested\"\n ],\n \"PULInterestedDismissNotInterestedReplyCategory\": [\n \"Interested\",\n \"Not Interested\"\n ],\n \"PULDismissInterestedDismissNotInterestedCategory\": [\n \"Interested\",\n \"Not Interested\"\n ],\n \"PULDismissInterestedDismissNotInterestedReplyCategory\": [\n \"Interested\",\n \"Not Interested\"\n ],\n \"PULLikeDislikeCategory\": [\n \"Like\",\n \"Dislike\"\n ],\n \"PULDismissLikeDislikeCategory\": [\n \"Like\",\n \"Dislike\"\n ],\n \"PULLikeDislikeReplyCategory\": [\n \"Like\",\n \"Dislike\"\n ],\n \"PULDismissLikeDislikeReplyCategory\": [\n \"Like\",\n \"Dislike\"\n ],\n \"PULLikeDismissDislikeCategory\": [\n \"Like\",\n \"Dislike\"\n ],\n \"PULLikeDismissDislikeReplyCategory\": [\n \"Like\",\n \"Dislike\"\n ],\n \"PULDismissLikeDismissDislikeCategory\": [\n \"Like\",\n \"Dislike\"\n ],\n \"PULDismissLikeDismissDislikeReplyCategory\": [\n \"Like\",\n \"Dislike\"\n ],\n \"PULMoreLikeThisLessLikeThisCategory\": [\n \"More Like This\",\n \"Less Like This\"\n ],\n \"PULDismissMoreLikeThisLessLikeThisCategory\": [\n \"More Like This\",\n \"Less Like This\"\n ],\n \"PULMoreLikeThisLessLikeThisReplyCategory\": [\n \"More Like This\",\n \"Less Like This\"\n ],\n \"PULDismissMoreLikeThisLessLikeThisReplyCategory\": [\n \"More Like This\",\n \"Less Like This\"\n ],\n \"PULMoreLikeThisDismissLessLikeThisCategory\": [\n \"More Like This\",\n \"Less Like This\"\n ],\n \"PULMoreLikeThisDismissLessLikeThisReplyCategory\": [\n \"More Like This\",\n \"Less Like This\"\n ],\n \"PULDismissMoreLikeThisDismissLessLikeThisCategory\": [\n \"More Like This\",\n \"Less Like This\"\n ],\n \"PULDismissMoreLikeThisDismissLessLikeThisReplyCategory\": [\n \"More Like This\",\n \"Less Like This\"\n ],\n \"PULOpt-InOpt-OutCategory\": [\n \"Opt-In\",\n \"Opt-Out\"\n ],\n \"PULDismissOpt-InOpt-OutCategory\": [\n \"Opt-In\",\n \"Opt-Out\"\n ],\n \"PULOpt-InOpt-OutReplyCategory\": [\n \"Opt-In\",\n \"Opt-Out\"\n ],\n \"PULDismissOpt-InOpt-OutReplyCategory\": [\n \"Opt-In\",\n \"Opt-Out\"\n ],\n \"PULOpt-InDismissOpt-OutCategory\": [\n \"Opt-In\",\n \"Opt-Out\"\n ],\n \"PULOpt-InDismissOpt-OutReplyCategory\": [\n \"Opt-In\",\n \"Opt-Out\"\n ],\n \"PULDismissOpt-InDismissOpt-OutCategory\": [\n \"Opt-In\",\n \"Opt-Out\"\n ],\n \"PULDismissOpt-InDismissOpt-OutReplyCategory\": [\n \"Opt-In\",\n \"Opt-Out\"\n ],\n \"PULYesNoCategory\": [\n \"Yes\",\n \"No\"\n ],\n \"PULDismissYesNoCategory\": [\n \"Yes\",\n \"No\"\n ],\n \"PULYesNoReplyCategory\": [\n \"Yes\",\n \"No\"\n ],\n \"PULDismissYesNoReplyCategory\": [\n \"Yes\",\n \"No\"\n ],\n \"PULYesDismissNoCategory\": [\n \"Yes\",\n \"No\"\n ],\n \"PULYesDismissNoReplyCategory\": [\n \"Yes\",\n \"No\"\n ],\n \"PULDismissYesDismissNoCategory\": [\n \"Yes\",\n \"No\"\n ],\n \"PULDismissYesDismissNoReplyCategory\": [\n \"Yes\",\n \"No\"\n ],\n \"PULAddtoCalendarCategory\": [\n \"Add to Calendar\"\n ],\n \"PULDismissAddtoCalendarCategory\": [\n \"Add to Calendar\"\n ],\n \"PULAddtoCalendarReplyCategory\": [\n \"Add to Calendar\"\n ],\n \"PULDismissAddtoCalendarReplyCategory\": [\n \"Add to Calendar\"\n ],\n \"PULBookNowCategory\": [\n \"Book Now\"\n ],\n \"PULDismissBookNowCategory\": [\n \"Book Now\"\n ],\n \"PULBookNowReplyCategory\": [\n \"Book Now\"\n ],\n \"PULDismissBookNowReplyCategory\": [\n \"Book Now\"\n ],\n \"PULBuyNowCategory\": [\n \"Buy Now\"\n ],\n \"PULDismissBuyNowCategory\": [\n \"Buy Now\"\n ],\n \"PULBuyNowReplyCategory\": [\n \"Buy Now\"\n ],\n \"PULDismissBuyNowReplyCategory\": [\n \"Buy Now\"\n ],\n \"PULCheckInCategory\": [\n \"Check In\"\n ],\n \"PULDismissCheckInCategory\": [\n \"Check In\"\n ],\n \"PULCheckInReplyCategory\": [\n \"Check In\"\n ],\n \"PULDismissCheckInReplyCategory\": [\n \"Check In\"\n ],\n \"PULDownloadCategory\": [\n \"Download\"\n ],\n \"PULDismissDownloadCategory\": [\n \"Download\"\n ],\n \"PULDownloadReplyCategory\": [\n \"Download\"\n ],\n \"PULDismissDownloadReplyCategory\": [\n \"Download\"\n ],\n \"PULFindOutMoreCategory\": [\n \"Find Out More\"\n ],\n \"PULDismissFindOutMoreCategory\": [\n \"Find Out More\"\n ],\n \"PULFindOutMoreReplyCategory\": [\n \"Find Out More\"\n ],\n \"PULDismissFindOutMoreReplyCategory\": [\n \"Find Out More\"\n ],\n \"PULFollowCategory\": [\n \"Follow\"\n ],\n \"PULDismissFollowCategory\": [\n \"Follow\"\n ],\n \"PULFollowReplyCategory\": [\n \"Follow\"\n ],\n \"PULDismissFollowReplyCategory\": [\n \"Follow\"\n ],\n \"PULGetCouponCategory\": [\n \"Get Coupon\"\n ],\n \"PULDismissGetCouponCategory\": [\n \"Get Coupon\"\n ],\n \"PULGetCouponReplyCategory\": [\n \"Get Coupon\"\n ],\n \"PULDismissGetCouponReplyCategory\": [\n \"Get Coupon\"\n ],\n \"PULGetDirectionsCategory\": [\n \"Get Directions\"\n ],\n \"PULDismissGetDirectionsCategory\": [\n \"Get Directions\"\n ],\n \"PULGetDirectionsReplyCategory\": [\n \"Get Directions\"\n ],\n \"PULDismissGetDirectionsReplyCategory\": [\n \"Get Directions\"\n ],\n \"PULLearnMoreCategory\": [\n \"Learn More\"\n ],\n \"PULDismissLearnMoreCategory\": [\n \"Learn More\"\n ],\n \"PULLearnMoreReplyCategory\": [\n \"Learn More\"\n ],\n \"PULDismissLearnMoreReplyCategory\": [\n \"Learn More\"\n ],\n \"PULMoreInfoCategory\": [\n \"More Info\"\n ],\n \"PULDismissMoreInfoCategory\": [\n \"More Info\"\n ],\n \"PULMoreInfoReplyCategory\": [\n \"More Info\"\n ],\n \"PULDismissMoreInfoReplyCategory\": [\n \"More Info\"\n ],\n \"PULOrderNowCategory\": [\n \"Order Now\"\n ],\n \"PULDismissOrderNowCategory\": [\n \"Order Now\"\n ],\n \"PULOrderNowReplyCategory\": [\n \"Order Now\"\n ],\n \"PULDismissOrderNowReplyCategory\": [\n \"Order Now\"\n ],\n \"PULRateNowCategory\": [\n \"Rate Now\"\n ],\n \"PULDismissRateNowCategory\": [\n \"Rate Now\"\n ],\n \"PULRateNowReplyCategory\": [\n \"Rate Now\"\n ],\n \"PULDismissRateNowReplyCategory\": [\n \"Rate Now\"\n ],\n \"PULShopNowCategory\": [\n \"Shop Now\"\n ],\n \"PULDismissShopNowCategory\": [\n \"Shop Now\"\n ],\n \"PULShopNowReplyCategory\": [\n \"Shop Now\"\n ],\n \"PULDismissShopNowReplyCategory\": [\n \"Shop Now\"\n ],\n \"PULSignUpCategory\": [\n \"Sign Up\"\n ],\n \"PULDismissSignUpCategory\": [\n \"Sign Up\"\n ],\n \"PULSignUpReplyCategory\": [\n \"Sign Up\"\n ],\n \"PULDismissSignUpReplyCategory\": [\n \"Sign Up\"\n ],\n \"PULUpdateCategory\": [\n \"Update\"\n ],\n \"PULDismissUpdateCategory\": [\n \"Update\"\n ],\n \"PULUpdateReplyCategory\": [\n \"Update\"\n ],\n \"PULDismissUpdateReplyCategory\": [\n \"Update\"\n ],\n \"PULUpgradeNowCategory\": [\n \"Upgrade Now\"\n ],\n \"PULDismissUpgradeNowCategory\": [\n \"Upgrade Now\"\n ],\n \"PULUpgradeNowReplyCategory\": [\n \"Upgrade Now\"\n ],\n \"PULDismissUpgradeNowReplyCategory\": [\n \"Upgrade Now\"\n ],\n \"PULViewCouponCategory\": [\n \"View Coupon\"\n ],\n \"PULDismissViewCouponCategory\": [\n \"View Coupon\"\n ],\n \"PULViewCouponReplyCategory\": [\n \"View Coupon\"\n ],\n \"PULDismissViewCouponReplyCategory\": [\n \"View Coupon\"\n ],\n \"PULViewMapCategory\": [\n \"View Map\"\n ],\n \"PULDismissViewMapCategory\": [\n \"View Map\"\n ],\n \"PULViewMapReplyCategory\": [\n \"View Map\"\n ],\n \"PULDismissViewMapReplyCategory\": [\n \"View Map\"\n ],\n \"PULViewMenuCategory\": [\n \"View Menu\"\n ],\n \"PULDismissViewMenuCategory\": [\n \"View Menu\"\n ],\n \"PULViewMenuReplyCategory\": [\n \"View Menu\"\n ],\n \"PULDismissViewMenuReplyCategory\": [\n \"View Menu\"\n ],\n \"PULViewMoreCategory\": [\n \"View More\"\n ],\n \"PULDismissViewMoreCategory\": [\n \"View More\"\n ],\n \"PULViewMoreReplyCategory\": [\n \"View More\"\n ],\n \"PULDismissViewMoreReplyCategory\": [\n \"View More\"\n ],\n \"PULViewOfferCategory\": [\n \"View Offer\"\n ],\n \"PULDismissViewOfferCategory\": [\n \"View Offer\"\n ],\n \"PULViewOfferReplyCategory\": [\n \"View Offer\"\n ],\n \"PULDismissViewOfferReplyCategory\": [\n \"View Offer\"\n ],\n \"PULDefaultCategory\": [\n\n ]\n}\n", "language": "json", "name": "" } ] } [/block] [block:api-header] { "type": "basic", "title": "Time Zones Names" } [/block] [block:code] { "codes": [ { "code": "[\n \"Africa/Algiers\",\n \"Africa/Cairo\",\n \"Africa/Casablanca\",\n \"Africa/Harare\",\n \"Africa/Johannesburg\",\n \"Africa/Monrovia\",\n \"Africa/Nairobi\",\n \"America/Argentina/Buenos_Aires\",\n \"America/Bogota\",\n \"America/Caracas\",\n \"America/Chicago\",\n \"America/Chihuahua\",\n \"America/Denver\",\n \"America/Godthab\",\n \"America/Guatemala\",\n \"America/Guyana\",\n \"America/Halifax\",\n \"America/Indiana/Indianapolis\",\n \"America/Juneau\",\n \"America/La_Paz\",\n \"America/Lima\",\n \"America/Los_Angeles\",\n \"America/Mazatlan\",\n \"America/Mexico_City\",\n \"America/Monterrey\",\n \"America/Montevideo\",\n \"America/New_York\",\n \"America/Phoenix\",\n \"America/Regina\",\n \"America/Santiago\",\n \"America/Sao_Paulo\",\n \"America/St_Johns\",\n \"America/Tijuana\",\n \"Asia/Almaty\",\n \"Asia/Baghdad\",\n \"Asia/Baku\",\n \"Asia/Bangkok\",\n \"Asia/Chongqing\",\n \"Asia/Colombo\",\n \"Asia/Dhaka\",\n \"Asia/Hong_Kong\",\n \"Asia/Irkutsk\",\n \"Asia/Jakarta\",\n \"Asia/Jerusalem\",\n \"Asia/Kabul\",\n \"Asia/Kamchatka\",\n \"Asia/Karachi\",\n \"Asia/Kathmandu\",\n \"Asia/Kolkata\",\n \"Asia/Krasnoyarsk\",\n \"Asia/Kuala_Lumpur\",\n \"Asia/Kuwait\",\n \"Asia/Magadan\",\n \"Asia/Muscat\",\n \"Asia/Novosibirsk\",\n \"Asia/Rangoon\",\n \"Asia/Riyadh\",\n \"Asia/Seoul\",\n \"Asia/Shanghai\",\n \"Asia/Singapore\",\n \"Asia/Taipei\",\n \"Asia/Tashkent\",\n \"Asia/Tbilisi\",\n \"Asia/Tehran\",\n \"Asia/Tokyo\",\n \"Asia/Ulaanbaatar\",\n \"Asia/Urumqi\",\n \"Asia/Vladivostok\",\n \"Asia/Yakutsk\",\n \"Asia/Yekaterinburg\",\n \"Asia/Yerevan\",\n \"Atlantic/Azores\",\n \"Atlantic/Cape_Verde\",\n \"Atlantic/South_Georgia\",\n \"Australia/Adelaide\",\n \"Australia/Brisbane\",\n \"Australia/Darwin\",\n \"Australia/Hobart\",\n \"Australia/Melbourne\",\n \"Australia/Perth\",\n \"Australia/Sydney\",\n \"Etc/UTC\",\n \"Europe/Amsterdam\",\n \"Europe/Athens\",\n \"Europe/Belgrade\",\n \"Europe/Berlin\",\n \"Europe/Bratislava\",\n \"Europe/Brussels\",\n \"Europe/Bucharest\",\n \"Europe/Budapest\",\n \"Europe/Copenhagen\",\n \"Europe/Dublin\",\n \"Europe/Helsinki\",\n \"Europe/Istanbul\",\n \"Europe/Kiev\",\n \"Europe/Lisbon\",\n \"Europe/Ljubljana\",\n \"Europe/London\",\n \"Europe/Madrid\",\n \"Europe/Minsk\",\n \"Europe/Moscow\",\n \"Europe/Paris\",\n \"Europe/Prague\",\n \"Europe/Riga\",\n \"Europe/Rome\",\n \"Europe/Sarajevo\",\n \"Europe/Skopje\",\n \"Europe/Sofia\",\n \"Europe/Stockholm\",\n \"Europe/Tallinn\",\n \"Europe/Vienna\",\n \"Europe/Vilnius\",\n \"Europe/Warsaw\",\n \"Europe/Zagreb\",\n \"Pacific/Apia\",\n \"Pacific/Auckland\",\n \"Pacific/Chatham\",\n \"Pacific/Fakaofo\",\n \"Pacific/Fiji\",\n \"Pacific/Guadalcanal\",\n \"Pacific/Guam\",\n \"Pacific/Honolulu\",\n \"Pacific/Majuro\",\n \"Pacific/Midway\",\n \"Pacific/Noumea\",\n \"Pacific/Pago_Pago\",\n \"Pacific/Port_Moresby\",\n \"Pacific/Tongatapu\"\n]", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Deeplink and url personalization" } [/block] 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. [block:code] { "codes": [ { "code": "# Urls\n{\n\t# First Name\n \"destination_url\": \"https://www.example.com?q={{firstName}}\"\n}\n\n{\n\t# Last Name\n \"destination_url\": \"https://www.example.com?q={{lastName}}\"\n}\n\n{\n\t# Full Name\n \"destination_url\": \"https://www.example.com?q={{fullName}}\"\n}\n \n{\n\t# Custom Tag named MyCustomTag\n \"destination_url\": \"https://www.example.com?q={{MyCustomTag}}\"\n}\n\n{\n\t# Custom Tag named MyCustomTag with fallback value\n \"destination_url\": \"https://www.example.com?q={{ MyCustomTag | default: 'default' }}\"\n}\n\n", "language": "json", "name": "URLs" }, { "code": "# Urls\n{\n\t# First Name\n \"destination_url\": \"myapp://deeplink?q={{firstName}}\"\n}\n\n{\n\t# Last Name\n \"destination_url\": \"myapp://deeplink?q={{lastName}}\"\n}\n\n{\n\t# Full Name\n \"destination_url\": \"myapp://deeplink?q={{fullName}}\"\n}\n \n{\n\t# Custom Tag named MyCustomTag\n \"destination_url\": \"myapp://deeplink?q={{MyCustomTag}}\"\n}\n\n{\n\t# Custom Tag named MyCustomTag with fallback value\n \"destination_url\": \"myapp://deeplink?q={{ MyCustomTag | default: 'default' }}\"\n}\n", "language": "json", "name": "Deeplinks" } ] } [/block] [block:callout] { "type": "warning", "title": "Push Variants and Push Notification", "body": "A campaign payload can include either *push_notification* or *push_variants* fields, but not both." } [/block] [block:callout] { "type": "info", "title": "Dispatch Rate and Control Group", "body": "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." } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}