{ "item": [ { "id": "9dd0a614-b2e5-41d9-948c-4f4997cec9c1", "name": "View notifications", "request": { "name": "View notifications", "description": { "content": "View the details of multiple notifications", "type": "text/plain" }, "url": { "path": [ "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "app_id", "value": "", "description": "(Required) The app ID that you want to view notifications from" }, { "disabled": false, "key": "limit", "value": "", "description": "How many notifications to return. Max is 50. Default is 50." }, { "disabled": false, "key": "offset", "value": "", "description": "Page offset. Default is 0. Results are sorted by queued_at in descending order. queued_at is a representation of the time that the notification was queued at." }, { "disabled": false, "key": "kind", "value": "", "description": "Kind of notifications returned:\n * unset - All notification types (default)\n * `0` - Dashboard only\n * `1` - API only\n * `3` - Automated only\n" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b4e2c1b0-0497-4ae4-b8db-213ed89f6a15", "name": "OK", "originalRequest": { "url": { "path": [ "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "kind", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total_count\": 7979,\n \"offset\": 22,\n \"limit\": 6174,\n \"notifications\": [\n {\n \"included_segments\": {\n \"value\": \"\"\n },\n \"excluded_segments\": {\n \"value\": \"\"\n },\n \"id\": \"string\",\n \"value\": 1682,\n \"aggregation\": \"sum\",\n \"external_id\": \"string\",\n \"idempotency_key\": \"string\",\n \"contents\": {\n \"value\": \"\",\n \"description\": \"Required unless content_available=true or template_id is set.\\nThe message's content (excluding the title), a map of language codes to text for each language.\\nEach hash must have a language code string for a key, mapped to the localized text you would like users to receive for that language.\\nThis field supports inline substitutions.\\nEnglish must be included in the hash.\\nExample: {\\\"en\\\": \\\"English Message\\\", \\\"es\\\": \\\"Spanish Message\\\"}\\n\",\n \"writeOnly\": true\n },\n \"headings\": {\n \"value\": \"\",\n \"description\": \"The message's title, a map of language codes to text for each language. Each hash must have a language code string for a key, mapped to the localized text you would like users to receive for that language.\\nThis field supports inline substitutions.\\nExample: {\\\"en\\\": \\\"English Title\\\", \\\"es\\\": \\\"Spanish Title\\\"}\\n\",\n \"writeOnly\": true\n },\n \"subtitle\": {\n \"value\": \"\",\n \"description\": \"The message's subtitle, a map of language codes to text for each language. Each hash must have a language code string for a key, mapped to the localized text you would like users to receive for that language.\\nThis field supports inline substitutions.\\nExample: {\\\"en\\\": \\\"English Subtitle\\\", \\\"es\\\": \\\"Spanish Subtitle\\\"}\\n\",\n \"writeOnly\": true\n },\n \"android_background_layout\": {\n \"image\": {\n \"value\": \"\"\n },\n \"headings_color\": {\n \"value\": \"\"\n },\n \"contents_color\": {\n \"value\": \"\"\n }\n },\n \"chrome_web_icon\": \"string\",\n \"web_push_topic\": \"string\",\n \"filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"successful\": 2778,\n \"failed\": 2159,\n \"errored\": 4587,\n \"converted\": 1214,\n \"received\": 2734,\n \"outcomes\": [\n {\n \"aggregation\": \"sum\",\n \"id\": \"string\",\n \"value\": 639\n },\n {\n \"aggregation\": \"sum\",\n \"id\": \"string\",\n \"value\": 9453\n }\n ],\n \"remaining\": 1139,\n \"queued_at\": 4417,\n \"send_after\": 8106,\n \"completed_at\": 7882,\n \"platform_delivery_stats\": {\n \"edge_web_push\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"chrome_web_push\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"firefox_web_push\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"safari_web_push\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"android\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"ios\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n },\n \"throttle_rate_per_minute\": 8168,\n \"canceled\": true,\n \"email_bcc\": [\n \"string\",\n \"string\"\n ],\n \"bcc_sent\": 2916\n },\n {\n \"included_segments\": {\n \"value\": \"\"\n },\n \"excluded_segments\": {\n \"value\": \"\"\n },\n \"id\": \"string\",\n \"value\": 3955,\n \"aggregation\": \"sum\",\n \"external_id\": \"string\",\n \"idempotency_key\": \"string\",\n \"contents\": {\n \"value\": \"\",\n \"description\": \"Required unless content_available=true or template_id is set.\\nThe message's content (excluding the title), a map of language codes to text for each language.\\nEach hash must have a language code string for a key, mapped to the localized text you would like users to receive for that language.\\nThis field supports inline substitutions.\\nEnglish must be included in the hash.\\nExample: {\\\"en\\\": \\\"English Message\\\", \\\"es\\\": \\\"Spanish Message\\\"}\\n\",\n \"writeOnly\": true\n },\n \"headings\": {\n \"value\": \"\",\n \"description\": \"The message's title, a map of language codes to text for each language. Each hash must have a language code string for a key, mapped to the localized text you would like users to receive for that language.\\nThis field supports inline substitutions.\\nExample: {\\\"en\\\": \\\"English Title\\\", \\\"es\\\": \\\"Spanish Title\\\"}\\n\",\n \"writeOnly\": true\n },\n \"subtitle\": {\n \"value\": \"\",\n \"description\": \"The message's subtitle, a map of language codes to text for each language. Each hash must have a language code string for a key, mapped to the localized text you would like users to receive for that language.\\nThis field supports inline substitutions.\\nExample: {\\\"en\\\": \\\"English Subtitle\\\", \\\"es\\\": \\\"Spanish Subtitle\\\"}\\n\",\n \"writeOnly\": true\n },\n \"android_background_layout\": {\n \"image\": {\n \"value\": \"\"\n },\n \"headings_color\": {\n \"value\": \"\"\n },\n \"contents_color\": {\n \"value\": \"\"\n }\n },\n \"chrome_web_icon\": \"string\",\n \"web_push_topic\": \"string\",\n \"filters\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"successful\": 8130,\n \"failed\": 3238,\n \"errored\": 6502,\n \"converted\": 9892,\n \"received\": 647,\n \"outcomes\": [\n {\n \"aggregation\": \"count\",\n \"id\": \"string\",\n \"value\": 2141\n },\n {\n \"aggregation\": \"count\",\n \"id\": \"string\",\n \"value\": 6416\n }\n ],\n \"remaining\": 6932,\n \"queued_at\": 2836,\n \"send_after\": 3914,\n \"completed_at\": 180,\n \"platform_delivery_stats\": {\n \"edge_web_push\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"chrome_web_push\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"firefox_web_push\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"safari_web_push\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"android\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"ios\": {\n \"successful\": {\n \"value\": \"\"\n },\n \"failed\": {\n \"value\": \"\"\n },\n \"errored\": {\n \"value\": \"\"\n },\n \"converted\": {\n \"value\": \"\"\n },\n \"received\": {\n \"value\": \"\"\n }\n },\n \"sms\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n }\n },\n \"throttle_rate_per_minute\": 7291,\n \"canceled\": false,\n \"email_bcc\": [\n \"string\",\n \"string\"\n ],\n \"bcc_sent\": 4694\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3a28e4b-d1fe-4277-bb13-cfab1c19727d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "kind", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a313fb4c-7a7d-4a7a-822f-522542a68a3a", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "notifications" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "kind", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8bd0869-d464-4908-878a-00573d8affcb", "name": "Create notification", "request": { "name": "Create notification", "description": { "content": "Sends notifications to your users.\n\n**Target by External ID (push example):** set `include_aliases` to `{ \"external_id\": [\"your-user-id\"] }` and set `target_channel` to `push` (or `email` / `sms` for those channels). Alias object keys must match API labels exactly (for example `external_id`, not camelCase).\n\n**Do not confuse** the notification-level `external_id` field with External ID targeting: top-level `external_id` / `idempotency_key` are for idempotent notification requests only, not for selecting recipients.\n\n**Targeting compatibility:** `include_aliases` must not be combined with other targeting modes (segments, filters, subscription IDs, legacy player IDs, etc.). Clients should send only one targeting strategy per request.\n", "type": "text/plain" }, "url": { "path": [ "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"app_id\": \"\",\n \"included_segments\": [\n \"\",\n \"\"\n ],\n \"excluded_segments\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"isIos\": \"\",\n \"isAndroid\": \"\",\n \"isHuawei\": \"\",\n \"isAnyWeb\": \"\",\n \"isChromeWeb\": \"\",\n \"isFirefox\": \"\",\n \"isSafari\": \"\",\n \"isWP_WNS\": \"\",\n \"isAdm\": \"\",\n \"isChrome\": \"\",\n \"external_id\": \"\",\n \"idempotency_key\": \"\",\n \"contents\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"headings\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"subtitle\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"data\": \"\",\n \"huawei_msg_type\": \"\",\n \"url\": \"\",\n \"web_url\": \"\",\n \"app_url\": \"\",\n \"ios_attachments\": \"\",\n \"template_id\": \"\",\n \"content_available\": \"\",\n \"mutable_content\": \"\",\n \"target_content_identifier\": \"\",\n \"big_picture\": \"\",\n \"huawei_big_picture\": \"\",\n \"adm_big_picture\": \"\",\n \"chrome_big_picture\": \"\",\n \"chrome_web_image\": \"\",\n \"buttons\": [\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\"\n },\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\"\n }\n ],\n \"web_buttons\": [\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\",\n \"url\": \"\"\n }\n ],\n \"ios_category\": \"\",\n \"android_channel_id\": \"\",\n \"huawei_channel_id\": \"\",\n \"existing_android_channel_id\": \"\",\n \"huawei_existing_channel_id\": \"\",\n \"android_background_layout\": {\n \"image\": \"\",\n \"headings_color\": \"\",\n \"contents_color\": \"\"\n },\n \"small_icon\": \"\",\n \"huawei_small_icon\": \"\",\n \"large_icon\": \"\",\n \"huawei_large_icon\": \"\",\n \"adm_small_icon\": \"\",\n \"adm_large_icon\": \"\",\n \"chrome_web_icon\": \"\",\n \"chrome_web_badge\": \"\",\n \"firefox_icon\": \"\",\n \"chrome_icon\": \"\",\n \"ios_sound\": \"\",\n \"android_sound\": \"\",\n \"huawei_sound\": \"\",\n \"adm_sound\": \"\",\n \"wp_wns_sound\": \"\",\n \"android_led_color\": \"\",\n \"huawei_led_color\": \"\",\n \"android_accent_color\": \"\",\n \"huawei_accent_color\": \"\",\n \"android_visibility\": \"\",\n \"huawei_visibility\": \"\",\n \"ios_badgeType\": \"\",\n \"ios_badgeCount\": \"\",\n \"collapse_id\": \"\",\n \"web_push_topic\": \"\",\n \"apns_alert\": \"\",\n \"delayed_option\": \"\",\n \"delivery_time_of_day\": \"\",\n \"ttl\": \"\",\n \"priority\": \"\",\n \"apns_push_type_override\": \"\",\n \"throttle_rate_per_minute\": \"\",\n \"android_group\": \"\",\n \"android_group_message\": \"\",\n \"adm_group\": \"\",\n \"adm_group_message\": \"\",\n \"thread_id\": \"\",\n \"summary_arg\": \"\",\n \"summary_arg_count\": \"\",\n \"ios_relevance_score\": \"\",\n \"ios_interruption_level\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"email_from_name\": \"\",\n \"email_from_address\": \"\",\n \"email_reply_to_address\": \"\",\n \"email_preheader\": \"\",\n \"disable_email_click_tracking\": \"\",\n \"include_unsubscribed\": \"\",\n \"email_bcc\": [\n \"\",\n \"\"\n ],\n \"sms_from\": \"\",\n \"sms_media_urls\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"key\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"hours_ago\": {\n \"value\": \"\"\n },\n \"radius\": {\n \"value\": \"\"\n },\n \"lat\": {\n \"value\": \"\"\n },\n \"long\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"key\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"hours_ago\": {\n \"value\": \"\"\n },\n \"radius\": {\n \"value\": \"\"\n },\n \"lat\": {\n \"value\": \"\"\n },\n \"long\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n }\n }\n ],\n \"custom_data\": \"\",\n \"huawei_badge_class\": \"\",\n \"huawei_badge_add_num\": \"\",\n \"huawei_badge_set_num\": \"\",\n \"huawei_category\": \"\",\n \"huawei_bi_tag\": \"\",\n \"send_after\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "78b2c45b-2ddd-4dee-995a-0c8501162f97", "name": "OK, invalid_aliases, or No Subscribed Players\nIf a message was successfully created, you will get a 200 response with a non-empty `id` for the notification.\nIf the 200 response contains `invalid_aliases`, that marks devices that exist in the provided app_id but are no longer subscribed.\nIf `id` is an empty string, no notification was created: check the `errors` array (for example messages such as \"All included players are not subscribed\") even though HTTP status is still 200. This can happen when alias keys are wrong, External IDs do not resolve to subscribed users, or other validation issues.\nIf no id is returned, then a message was not created and the targeted User IDs do not exist under the provided app_id.\nAny User IDs sent in the request that do not exist under the specified app_id will be ignored.\n", "originalRequest": { "url": { "path": [ "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": \"\",\n \"included_segments\": [\n \"\",\n \"\"\n ],\n \"excluded_segments\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"isIos\": \"\",\n \"isAndroid\": \"\",\n \"isHuawei\": \"\",\n \"isAnyWeb\": \"\",\n \"isChromeWeb\": \"\",\n \"isFirefox\": \"\",\n \"isSafari\": \"\",\n \"isWP_WNS\": \"\",\n \"isAdm\": \"\",\n \"isChrome\": \"\",\n \"external_id\": \"\",\n \"idempotency_key\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"subtitle\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"data\": \"\",\n \"huawei_msg_type\": \"\",\n \"url\": \"\",\n \"web_url\": \"\",\n \"app_url\": \"\",\n \"ios_attachments\": \"\",\n \"template_id\": \"\",\n \"content_available\": \"\",\n \"mutable_content\": \"\",\n \"target_content_identifier\": \"\",\n \"big_picture\": \"\",\n \"huawei_big_picture\": \"\",\n \"adm_big_picture\": \"\",\n \"chrome_big_picture\": \"\",\n \"chrome_web_image\": \"\",\n \"buttons\": [\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\"\n },\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\"\n }\n ],\n \"web_buttons\": [\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\",\n \"url\": \"\"\n }\n ],\n \"ios_category\": \"\",\n \"android_channel_id\": \"\",\n \"huawei_channel_id\": \"\",\n \"existing_android_channel_id\": \"\",\n \"huawei_existing_channel_id\": \"\",\n \"android_background_layout\": {\n \"image\": \"\",\n \"headings_color\": \"\",\n \"contents_color\": \"\"\n },\n \"small_icon\": \"\",\n \"huawei_small_icon\": \"\",\n \"large_icon\": \"\",\n \"huawei_large_icon\": \"\",\n \"adm_small_icon\": \"\",\n \"adm_large_icon\": \"\",\n \"chrome_web_icon\": \"\",\n \"chrome_web_badge\": \"\",\n \"firefox_icon\": \"\",\n \"chrome_icon\": \"\",\n \"ios_sound\": \"\",\n \"android_sound\": \"\",\n \"huawei_sound\": \"\",\n \"adm_sound\": \"\",\n \"wp_wns_sound\": \"\",\n \"android_led_color\": \"\",\n \"huawei_led_color\": \"\",\n \"android_accent_color\": \"\",\n \"huawei_accent_color\": \"\",\n \"android_visibility\": \"\",\n \"huawei_visibility\": \"\",\n \"ios_badgeType\": \"\",\n \"ios_badgeCount\": \"\",\n \"collapse_id\": \"\",\n \"web_push_topic\": \"\",\n \"apns_alert\": \"\",\n \"delayed_option\": \"\",\n \"delivery_time_of_day\": \"\",\n \"ttl\": \"\",\n \"priority\": \"\",\n \"apns_push_type_override\": \"\",\n \"throttle_rate_per_minute\": \"\",\n \"android_group\": \"\",\n \"android_group_message\": \"\",\n \"adm_group\": \"\",\n \"adm_group_message\": \"\",\n \"thread_id\": \"\",\n \"summary_arg\": \"\",\n \"summary_arg_count\": \"\",\n \"ios_relevance_score\": \"\",\n \"ios_interruption_level\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"email_from_name\": \"\",\n \"email_from_address\": \"\",\n \"email_reply_to_address\": \"\",\n \"email_preheader\": \"\",\n \"disable_email_click_tracking\": \"\",\n \"include_unsubscribed\": \"\",\n \"email_bcc\": [\n \"\",\n \"\"\n ],\n \"sms_from\": \"\",\n \"sms_media_urls\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"key\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"hours_ago\": {\n \"value\": \"\"\n },\n \"radius\": {\n \"value\": \"\"\n },\n \"lat\": {\n \"value\": \"\"\n },\n \"long\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"key\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"hours_ago\": {\n \"value\": \"\"\n },\n \"radius\": {\n \"value\": \"\"\n },\n \"lat\": {\n \"value\": \"\"\n },\n \"long\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n }\n }\n ],\n \"custom_data\": \"\",\n \"huawei_badge_class\": \"\",\n \"huawei_badge_add_num\": \"\",\n \"huawei_badge_set_num\": \"\",\n \"huawei_category\": \"\",\n \"huawei_bi_tag\": \"\",\n \"send_after\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"external_id\": \"string\",\n \"errors\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d85986bd-5733-491b-b866-6923e9a9019b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": \"\",\n \"included_segments\": [\n \"\",\n \"\"\n ],\n \"excluded_segments\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"isIos\": \"\",\n \"isAndroid\": \"\",\n \"isHuawei\": \"\",\n \"isAnyWeb\": \"\",\n \"isChromeWeb\": \"\",\n \"isFirefox\": \"\",\n \"isSafari\": \"\",\n \"isWP_WNS\": \"\",\n \"isAdm\": \"\",\n \"isChrome\": \"\",\n \"external_id\": \"\",\n \"idempotency_key\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"subtitle\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"data\": \"\",\n \"huawei_msg_type\": \"\",\n \"url\": \"\",\n \"web_url\": \"\",\n \"app_url\": \"\",\n \"ios_attachments\": \"\",\n \"template_id\": \"\",\n \"content_available\": \"\",\n \"mutable_content\": \"\",\n \"target_content_identifier\": \"\",\n \"big_picture\": \"\",\n \"huawei_big_picture\": \"\",\n \"adm_big_picture\": \"\",\n \"chrome_big_picture\": \"\",\n \"chrome_web_image\": \"\",\n \"buttons\": [\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\"\n },\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\"\n }\n ],\n \"web_buttons\": [\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\",\n \"url\": \"\"\n }\n ],\n \"ios_category\": \"\",\n \"android_channel_id\": \"\",\n \"huawei_channel_id\": \"\",\n \"existing_android_channel_id\": \"\",\n \"huawei_existing_channel_id\": \"\",\n \"android_background_layout\": {\n \"image\": \"\",\n \"headings_color\": \"\",\n \"contents_color\": \"\"\n },\n \"small_icon\": \"\",\n \"huawei_small_icon\": \"\",\n \"large_icon\": \"\",\n \"huawei_large_icon\": \"\",\n \"adm_small_icon\": \"\",\n \"adm_large_icon\": \"\",\n \"chrome_web_icon\": \"\",\n \"chrome_web_badge\": \"\",\n \"firefox_icon\": \"\",\n \"chrome_icon\": \"\",\n \"ios_sound\": \"\",\n \"android_sound\": \"\",\n \"huawei_sound\": \"\",\n \"adm_sound\": \"\",\n \"wp_wns_sound\": \"\",\n \"android_led_color\": \"\",\n \"huawei_led_color\": \"\",\n \"android_accent_color\": \"\",\n \"huawei_accent_color\": \"\",\n \"android_visibility\": \"\",\n \"huawei_visibility\": \"\",\n \"ios_badgeType\": \"\",\n \"ios_badgeCount\": \"\",\n \"collapse_id\": \"\",\n \"web_push_topic\": \"\",\n \"apns_alert\": \"\",\n \"delayed_option\": \"\",\n \"delivery_time_of_day\": \"\",\n \"ttl\": \"\",\n \"priority\": \"\",\n \"apns_push_type_override\": \"\",\n \"throttle_rate_per_minute\": \"\",\n \"android_group\": \"\",\n \"android_group_message\": \"\",\n \"adm_group\": \"\",\n \"adm_group_message\": \"\",\n \"thread_id\": \"\",\n \"summary_arg\": \"\",\n \"summary_arg_count\": \"\",\n \"ios_relevance_score\": \"\",\n \"ios_interruption_level\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"email_from_name\": \"\",\n \"email_from_address\": \"\",\n \"email_reply_to_address\": \"\",\n \"email_preheader\": \"\",\n \"disable_email_click_tracking\": \"\",\n \"include_unsubscribed\": \"\",\n \"email_bcc\": [\n \"\",\n \"\"\n ],\n \"sms_from\": \"\",\n \"sms_media_urls\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"key\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"hours_ago\": {\n \"value\": \"\"\n },\n \"radius\": {\n \"value\": \"\"\n },\n \"lat\": {\n \"value\": \"\"\n },\n \"long\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"key\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"hours_ago\": {\n \"value\": \"\"\n },\n \"radius\": {\n \"value\": \"\"\n },\n \"lat\": {\n \"value\": \"\"\n },\n \"long\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n }\n }\n ],\n \"custom_data\": \"\",\n \"huawei_badge_class\": \"\",\n \"huawei_badge_add_num\": \"\",\n \"huawei_badge_set_num\": \"\",\n \"huawei_category\": \"\",\n \"huawei_bi_tag\": \"\",\n \"send_after\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d27369b3-7226-4d02-8183-4ed3b398dd6c", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": \"\",\n \"included_segments\": [\n \"\",\n \"\"\n ],\n \"excluded_segments\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"isIos\": \"\",\n \"isAndroid\": \"\",\n \"isHuawei\": \"\",\n \"isAnyWeb\": \"\",\n \"isChromeWeb\": \"\",\n \"isFirefox\": \"\",\n \"isSafari\": \"\",\n \"isWP_WNS\": \"\",\n \"isAdm\": \"\",\n \"isChrome\": \"\",\n \"external_id\": \"\",\n \"idempotency_key\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"subtitle\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"data\": \"\",\n \"huawei_msg_type\": \"\",\n \"url\": \"\",\n \"web_url\": \"\",\n \"app_url\": \"\",\n \"ios_attachments\": \"\",\n \"template_id\": \"\",\n \"content_available\": \"\",\n \"mutable_content\": \"\",\n \"target_content_identifier\": \"\",\n \"big_picture\": \"\",\n \"huawei_big_picture\": \"\",\n \"adm_big_picture\": \"\",\n \"chrome_big_picture\": \"\",\n \"chrome_web_image\": \"\",\n \"buttons\": [\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\"\n },\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\"\n }\n ],\n \"web_buttons\": [\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"text\": \"\",\n \"icon\": \"\",\n \"url\": \"\"\n }\n ],\n \"ios_category\": \"\",\n \"android_channel_id\": \"\",\n \"huawei_channel_id\": \"\",\n \"existing_android_channel_id\": \"\",\n \"huawei_existing_channel_id\": \"\",\n \"android_background_layout\": {\n \"image\": \"\",\n \"headings_color\": \"\",\n \"contents_color\": \"\"\n },\n \"small_icon\": \"\",\n \"huawei_small_icon\": \"\",\n \"large_icon\": \"\",\n \"huawei_large_icon\": \"\",\n \"adm_small_icon\": \"\",\n \"adm_large_icon\": \"\",\n \"chrome_web_icon\": \"\",\n \"chrome_web_badge\": \"\",\n \"firefox_icon\": \"\",\n \"chrome_icon\": \"\",\n \"ios_sound\": \"\",\n \"android_sound\": \"\",\n \"huawei_sound\": \"\",\n \"adm_sound\": \"\",\n \"wp_wns_sound\": \"\",\n \"android_led_color\": \"\",\n \"huawei_led_color\": \"\",\n \"android_accent_color\": \"\",\n \"huawei_accent_color\": \"\",\n \"android_visibility\": \"\",\n \"huawei_visibility\": \"\",\n \"ios_badgeType\": \"\",\n \"ios_badgeCount\": \"\",\n \"collapse_id\": \"\",\n \"web_push_topic\": \"\",\n \"apns_alert\": \"\",\n \"delayed_option\": \"\",\n \"delivery_time_of_day\": \"\",\n \"ttl\": \"\",\n \"priority\": \"\",\n \"apns_push_type_override\": \"\",\n \"throttle_rate_per_minute\": \"\",\n \"android_group\": \"\",\n \"android_group_message\": \"\",\n \"adm_group\": \"\",\n \"adm_group_message\": \"\",\n \"thread_id\": \"\",\n \"summary_arg\": \"\",\n \"summary_arg_count\": \"\",\n \"ios_relevance_score\": \"\",\n \"ios_interruption_level\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"email_from_name\": \"\",\n \"email_from_address\": \"\",\n \"email_reply_to_address\": \"\",\n \"email_preheader\": \"\",\n \"disable_email_click_tracking\": \"\",\n \"include_unsubscribed\": \"\",\n \"email_bcc\": [\n \"\",\n \"\"\n ],\n \"sms_from\": \"\",\n \"sms_media_urls\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"key\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"hours_ago\": {\n \"value\": \"\"\n },\n \"radius\": {\n \"value\": \"\"\n },\n \"lat\": {\n \"value\": \"\"\n },\n \"long\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"key\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"hours_ago\": {\n \"value\": \"\"\n },\n \"radius\": {\n \"value\": \"\"\n },\n \"lat\": {\n \"value\": \"\"\n },\n \"long\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n }\n }\n ],\n \"custom_data\": \"\",\n \"huawei_badge_class\": \"\",\n \"huawei_badge_add_num\": \"\",\n \"huawei_badge_set_num\": \"\",\n \"huawei_category\": \"\",\n \"huawei_bi_tag\": \"\",\n \"send_after\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0432cdc4-47ef-4d79-8004-4112e746e431", "name": "Stop a scheduled or currently outgoing notification", "request": { "name": "Stop a scheduled or currently outgoing notification", "description": { "content": "Used to stop a scheduled or currently outgoing notification", "type": "text/plain" }, "url": { "path": [ "notifications", ":notification_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "app_id", "value": "", "description": "(Required) " } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7181041c-5722-47f3-a389-2475a93aa5ce", "name": "OK", "originalRequest": { "url": { "path": [ "notifications", ":notification_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bff9c84-ea6a-4d39-a2a9-6ec721d78705", "name": "Bad Request", "originalRequest": { "url": { "path": [ "notifications", ":notification_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cd597bb-1e1c-427c-a731-cf8c43845e6a", "name": "Not Found", "originalRequest": { "url": { "path": [ "notifications", ":notification_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbd5de47-bc33-4b89-ad4b-ebf45849d84b", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "notifications", ":notification_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bdc5f10-67d6-4c40-b1ee-4621ccbbcf45", "name": "View notification", "request": { "name": "View notification", "description": { "content": "View the details of a single notification and outcomes associated with it", "type": "text/plain" }, "url": { "path": [ "notifications", ":notification_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "app_id", "value": "", "description": "(Required) " } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cb3816b0-8c49-4f7b-b0c8-9b277391a4ab", "name": "OK", "originalRequest": { "url": { "path": [ "notifications", ":notification_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"included_segments\": [\n \"\",\n \"\"\n ],\n \"excluded_segments\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"value\": 3618,\n \"aggregation\": \"sum\",\n \"external_id\": \"\",\n \"idempotency_key\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"subtitle\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"android_background_layout\": {\n \"image\": \"\",\n \"headings_color\": \"\",\n \"contents_color\": \"\"\n },\n \"chrome_web_icon\": \"\",\n \"web_push_topic\": \"\",\n \"filters\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"key\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"hours_ago\": {\n \"value\": \"\"\n },\n \"radius\": {\n \"value\": \"\"\n },\n \"lat\": {\n \"value\": \"\"\n },\n \"long\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"key\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"hours_ago\": {\n \"value\": \"\"\n },\n \"radius\": {\n \"value\": \"\"\n },\n \"lat\": {\n \"value\": \"\"\n },\n \"long\": {\n \"value\": \"\"\n },\n \"relation\": {\n \"value\": \"\"\n }\n }\n ],\n \"successful\": 5607,\n \"failed\": 2716,\n \"errored\": 3895,\n \"converted\": 4998,\n \"received\": 7659,\n \"outcomes\": [\n {\n \"aggregation\": \"sum\",\n \"id\": \"string\",\n \"value\": 6453\n },\n {\n \"aggregation\": \"count\",\n \"id\": \"string\",\n \"value\": 4069\n }\n ],\n \"remaining\": 8178,\n \"queued_at\": 9920,\n \"send_after\": 6931,\n \"completed_at\": 2464,\n \"platform_delivery_stats\": {\n \"edge_web_push\": {\n \"successful\": 9448,\n \"failed\": 6235,\n \"errored\": 5458,\n \"converted\": 1388,\n \"received\": 741\n },\n \"chrome_web_push\": {\n \"successful\": 7220,\n \"failed\": 2385,\n \"errored\": 1385,\n \"converted\": 1618,\n \"received\": 602\n },\n \"firefox_web_push\": {\n \"successful\": 8032,\n \"failed\": 6798,\n \"errored\": 5086,\n \"converted\": 7644,\n \"received\": 9513\n },\n \"safari_web_push\": {\n \"successful\": 2154,\n \"failed\": 2870,\n \"errored\": 4936,\n \"converted\": 7455,\n \"received\": 2066\n },\n \"android\": {\n \"successful\": 1462,\n \"failed\": 4501,\n \"errored\": 3144,\n \"converted\": 1845,\n \"received\": 6487\n },\n \"ios\": {\n \"successful\": 5477,\n \"failed\": 6741,\n \"errored\": 4238,\n \"converted\": 9966,\n \"received\": 2819\n },\n \"sms\": {\n \"successful\": 1975,\n \"failed\": 8329,\n \"errored\": 4855,\n \"converted\": 3393,\n \"received\": 9098,\n \"provider_successful\": 7509,\n \"provider_failed\": 6182,\n \"provider_errored\": 430\n },\n \"email\": {\n \"successful\": 9605,\n \"failed\": 4625,\n \"errored\": 677,\n \"converted\": 840,\n \"received\": 2605,\n \"opened\": 4749,\n \"unique_opens\": 9941,\n \"clicks\": 3807,\n \"unique_clicks\": 7245,\n \"bounced\": 6979,\n \"reported_spam\": 1151,\n \"unsubscribed\": 8929\n }\n },\n \"throttle_rate_per_minute\": 9845,\n \"canceled\": true,\n \"email_bcc\": [\n \"string\",\n \"string\"\n ],\n \"bcc_sent\": 8181\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19aac4df-eaba-4e62-b096-6a83b585cac8", "name": "Bad Request", "originalRequest": { "url": { "path": [ "notifications", ":notification_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8cc258d-b3d8-49f9-b146-f4d662547239", "name": "Not Found", "originalRequest": { "url": { "path": [ "notifications", ":notification_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1f227ae-62de-4d6c-bae6-8cc843f18524", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "notifications", ":notification_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "28aac6ba-57f7-479b-8107-c854c2b4675d", "name": "Notification History", "request": { "name": "Notification History", "description": { "content": "-> View the devices sent a message - OneSignal Paid Plan Required This method will return all devices that were sent the given notification_id of an Email or Push Notification if used within 7 days of the date sent. After 7 days of the sending date, the message history data will be unavailable. After a successful response is received, the destination url may be polled until the file becomes available. Most exports are done in ~1-3 minutes, so setting a poll interval of 10 seconds should be adequate. For use cases that are not meant to be consumed by a script, an email will be sent to the supplied email address. 🚧 Requirements A OneSignal Paid Plan. Turn on Send History via OneSignal API in Settings -> Analytics. Cannot get data before this was turned on. Must be called within 7 days after sending the message. Messages targeting under 1000 recipients will not have \"sent\" events recorded, but will show \"clicked\" events. Requires your OneSignal App's REST API Key, available in Keys & IDs.", "type": "text/plain" }, "url": { "path": [ "notifications", ":notification_id", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The \"id\" of the message found in the Notification object" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"events\": \"\",\n \"email\": \"\",\n \"app_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "354a417e-b651-4a8a-9c12-aef9111ecc70", "name": "OK", "originalRequest": { "url": { "path": [ "notifications", ":notification_id", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The \"id\" of the message found in the Notification object" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": \"clicked\",\n \"email\": \"string\",\n \"app_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"destination_url\": \"destination_url\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c0030d4-523b-4fb9-a7ba-4d1a82d7ee70", "name": "Bad Request", "originalRequest": { "url": { "path": [ "notifications", ":notification_id", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The \"id\" of the message found in the Notification object" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": \"clicked\",\n \"email\": \"string\",\n \"app_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01266c91-88db-453f-ad20-5dfa25735fd7", "name": "Not Found", "originalRequest": { "url": { "path": [ "notifications", ":notification_id", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The \"id\" of the message found in the Notification object" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": \"clicked\",\n \"email\": \"string\",\n \"app_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaeb404b-e501-4148-9cc8-e07cfc272da3", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "notifications", ":notification_id", "history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The \"id\" of the message found in the Notification object" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": \"clicked\",\n \"email\": \"string\",\n \"app_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a824b7f6-2435-4d91-8d1d-294091c6aaa4", "name": "View apps", "request": { "name": "View apps", "description": { "content": "View the details of all of your current OneSignal apps", "type": "text/plain" }, "url": { "path": [ "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b5288753-850b-40ea-9a5b-98013e01f1dd", "name": "OK", "originalRequest": { "url": { "path": [ "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"apns_key_id\": \"apns_key_id\",\n \"apns_team_id\": \"apns_team_id\",\n \"apns_p12\": \"apns_p12\",\n \"safari_site_origin\": \"safari_site_origin\",\n \"apns_p12_password\": \"apns_p12_password\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"safari_icon_64_64\": \"safari_icon_64_64\",\n \"chrome_web_sub_domain\": \"chrome_web_sub_domain\",\n \"gcm_key\": \"gcm_key\",\n \"apns_bundle_id\": \"apns_bundle_id\",\n \"chrome_key\": \"chrome_key\",\n \"safari_push_id\": \"safari_push_id\",\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"apns_certificates\": \"apns_certificates\",\n \"safari_apns_p12\": \"safari_apns_p12\",\n \"safari_icon_128_128\": \"safari_icon_128_128\",\n \"android_gcm_sender_id\": \"android_gcm_sender_id\",\n \"safari_icon_32_32\": \"safari_icon_32_32\",\n \"additional_data_is_root_payload\": true,\n \"apns_env\": \"sandbox\",\n \"players\": 0,\n \"messageable_players\": 6,\n \"apns_p8\": \"apns_p8\",\n \"chrome_web_origin\": \"chrome_web_origin\",\n \"basic_auth_key\": \"basic_auth_key\",\n \"site_name\": \"site_name\",\n \"safari_icon_16_16\": \"safari_icon_16_16\",\n \"chrome_web_default_notification_icon\": \"chrome_web_default_notification_icon\",\n \"organization_id\": \"organization_id\",\n \"name\": \"name\",\n \"safari_apns_certificates\": \"safari_apns_certificates\",\n \"safari_apns_p12_password\": \"safari_apns_p12_password\",\n \"safari_icon_256_256\": \"safari_icon_256_256\"\n },\n {\n \"apns_key_id\": \"apns_key_id\",\n \"apns_team_id\": \"apns_team_id\",\n \"apns_p12\": \"apns_p12\",\n \"safari_site_origin\": \"safari_site_origin\",\n \"apns_p12_password\": \"apns_p12_password\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"safari_icon_64_64\": \"safari_icon_64_64\",\n \"chrome_web_sub_domain\": \"chrome_web_sub_domain\",\n \"gcm_key\": \"gcm_key\",\n \"apns_bundle_id\": \"apns_bundle_id\",\n \"chrome_key\": \"chrome_key\",\n \"safari_push_id\": \"safari_push_id\",\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"apns_certificates\": \"apns_certificates\",\n \"safari_apns_p12\": \"safari_apns_p12\",\n \"safari_icon_128_128\": \"safari_icon_128_128\",\n \"android_gcm_sender_id\": \"android_gcm_sender_id\",\n \"safari_icon_32_32\": \"safari_icon_32_32\",\n \"additional_data_is_root_payload\": true,\n \"apns_env\": \"sandbox\",\n \"players\": 0,\n \"messageable_players\": 6,\n \"apns_p8\": \"apns_p8\",\n \"chrome_web_origin\": \"chrome_web_origin\",\n \"basic_auth_key\": \"basic_auth_key\",\n \"site_name\": \"site_name\",\n \"safari_icon_16_16\": \"safari_icon_16_16\",\n \"chrome_web_default_notification_icon\": \"chrome_web_default_notification_icon\",\n \"organization_id\": \"organization_id\",\n \"name\": \"name\",\n \"safari_apns_certificates\": \"safari_apns_certificates\",\n \"safari_apns_p12_password\": \"safari_apns_p12_password\",\n \"safari_icon_256_256\": \"safari_icon_256_256\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b6fd52c-45b5-4032-bb41-e7602dc8bcfd", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5abe456-67aa-47d4-954a-95cc0d932ba3", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cce6812d-25e2-428a-8fb3-04e267629379", "name": "Create an app", "request": { "name": "Create an app", "description": { "content": "Creates a new OneSignal app", "type": "text/plain" }, "url": { "path": [ "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"android_gcm_sender_id\": \"\",\n \"gcm_key\": \"\",\n \"chrome_web_origin\": \"\",\n \"chrome_key\": \"\",\n \"chrome_web_default_notification_icon\": \"\",\n \"chrome_web_sub_domain\": \"\",\n \"apns_env\": \"\",\n \"apns_p12\": \"\",\n \"apns_p12_password\": \"\",\n \"safari_apns_p12\": \"\",\n \"safari_apns_p12_password\": \"\",\n \"apns_key_id\": \"\",\n \"apns_team_id\": \"\",\n \"apns_bundle_id\": \"\",\n \"apns_p8\": \"\",\n \"safari_site_origin\": \"\",\n \"safari_icon_256_256\": \"\",\n \"site_name\": \"\",\n \"organization_id\": \"\",\n \"additional_data_is_root_payload\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "75cd9b69-ebb8-4dd3-b097-b3a36379901d", "name": "OK", "originalRequest": { "url": { "path": [ "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apns_key_id\": \"apns_key_id\",\n \"apns_team_id\": \"apns_team_id\",\n \"apns_p12\": \"apns_p12\",\n \"safari_site_origin\": \"safari_site_origin\",\n \"apns_p12_password\": \"apns_p12_password\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"safari_icon_64_64\": \"safari_icon_64_64\",\n \"chrome_web_sub_domain\": \"chrome_web_sub_domain\",\n \"gcm_key\": \"gcm_key\",\n \"apns_bundle_id\": \"apns_bundle_id\",\n \"chrome_key\": \"chrome_key\",\n \"safari_push_id\": \"safari_push_id\",\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"apns_certificates\": \"apns_certificates\",\n \"safari_apns_p12\": \"safari_apns_p12\",\n \"safari_icon_128_128\": \"safari_icon_128_128\",\n \"android_gcm_sender_id\": \"android_gcm_sender_id\",\n \"safari_icon_32_32\": \"safari_icon_32_32\",\n \"additional_data_is_root_payload\": true,\n \"apns_env\": \"sandbox\",\n \"players\": 0,\n \"messageable_players\": 6,\n \"apns_p8\": \"apns_p8\",\n \"chrome_web_origin\": \"chrome_web_origin\",\n \"basic_auth_key\": \"basic_auth_key\",\n \"site_name\": \"site_name\",\n \"safari_icon_16_16\": \"safari_icon_16_16\",\n \"chrome_web_default_notification_icon\": \"chrome_web_default_notification_icon\",\n \"organization_id\": \"organization_id\",\n \"name\": \"name\",\n \"safari_apns_certificates\": \"safari_apns_certificates\",\n \"safari_apns_p12_password\": \"safari_apns_p12_password\",\n \"safari_icon_256_256\": \"safari_icon_256_256\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"apns_key_id\": \"apns_key_id\",\n \"apns_team_id\": \"apns_team_id\",\n \"apns_p12\": \"apns_p12\",\n \"safari_site_origin\": \"safari_site_origin\",\n \"apns_p12_password\": \"apns_p12_password\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"safari_icon_64_64\": \"safari_icon_64_64\",\n \"chrome_web_sub_domain\": \"chrome_web_sub_domain\",\n \"gcm_key\": \"gcm_key\",\n \"apns_bundle_id\": \"apns_bundle_id\",\n \"chrome_key\": \"chrome_key\",\n \"safari_push_id\": \"safari_push_id\",\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"apns_certificates\": \"apns_certificates\",\n \"safari_apns_p12\": \"safari_apns_p12\",\n \"safari_icon_128_128\": \"safari_icon_128_128\",\n \"android_gcm_sender_id\": \"android_gcm_sender_id\",\n \"safari_icon_32_32\": \"safari_icon_32_32\",\n \"additional_data_is_root_payload\": true,\n \"apns_env\": \"sandbox\",\n \"players\": 0,\n \"messageable_players\": 6,\n \"apns_p8\": \"apns_p8\",\n \"chrome_web_origin\": \"chrome_web_origin\",\n \"basic_auth_key\": \"basic_auth_key\",\n \"site_name\": \"site_name\",\n \"safari_icon_16_16\": \"safari_icon_16_16\",\n \"chrome_web_default_notification_icon\": \"chrome_web_default_notification_icon\",\n \"organization_id\": \"organization_id\",\n \"name\": \"name\",\n \"safari_apns_certificates\": \"safari_apns_certificates\",\n \"safari_apns_p12_password\": \"safari_apns_p12_password\",\n \"safari_icon_256_256\": \"safari_icon_256_256\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b39a398-6e1c-4f77-9061-03be8ff048b4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apns_key_id\": \"apns_key_id\",\n \"apns_team_id\": \"apns_team_id\",\n \"apns_p12\": \"apns_p12\",\n \"safari_site_origin\": \"safari_site_origin\",\n \"apns_p12_password\": \"apns_p12_password\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"safari_icon_64_64\": \"safari_icon_64_64\",\n \"chrome_web_sub_domain\": \"chrome_web_sub_domain\",\n \"gcm_key\": \"gcm_key\",\n \"apns_bundle_id\": \"apns_bundle_id\",\n \"chrome_key\": \"chrome_key\",\n \"safari_push_id\": \"safari_push_id\",\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"apns_certificates\": \"apns_certificates\",\n \"safari_apns_p12\": \"safari_apns_p12\",\n \"safari_icon_128_128\": \"safari_icon_128_128\",\n \"android_gcm_sender_id\": \"android_gcm_sender_id\",\n \"safari_icon_32_32\": \"safari_icon_32_32\",\n \"additional_data_is_root_payload\": true,\n \"apns_env\": \"sandbox\",\n \"players\": 0,\n \"messageable_players\": 6,\n \"apns_p8\": \"apns_p8\",\n \"chrome_web_origin\": \"chrome_web_origin\",\n \"basic_auth_key\": \"basic_auth_key\",\n \"site_name\": \"site_name\",\n \"safari_icon_16_16\": \"safari_icon_16_16\",\n \"chrome_web_default_notification_icon\": \"chrome_web_default_notification_icon\",\n \"organization_id\": \"organization_id\",\n \"name\": \"name\",\n \"safari_apns_certificates\": \"safari_apns_certificates\",\n \"safari_apns_p12_password\": \"safari_apns_p12_password\",\n \"safari_icon_256_256\": \"safari_icon_256_256\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd0540e7-7243-495f-86a0-a340e0907b9b", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"apns_key_id\": \"apns_key_id\",\n \"apns_team_id\": \"apns_team_id\",\n \"apns_p12\": \"apns_p12\",\n \"safari_site_origin\": \"safari_site_origin\",\n \"apns_p12_password\": \"apns_p12_password\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"safari_icon_64_64\": \"safari_icon_64_64\",\n \"chrome_web_sub_domain\": \"chrome_web_sub_domain\",\n \"gcm_key\": \"gcm_key\",\n \"apns_bundle_id\": \"apns_bundle_id\",\n \"chrome_key\": \"chrome_key\",\n \"safari_push_id\": \"safari_push_id\",\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"apns_certificates\": \"apns_certificates\",\n \"safari_apns_p12\": \"safari_apns_p12\",\n \"safari_icon_128_128\": \"safari_icon_128_128\",\n \"android_gcm_sender_id\": \"android_gcm_sender_id\",\n \"safari_icon_32_32\": \"safari_icon_32_32\",\n \"additional_data_is_root_payload\": true,\n \"apns_env\": \"sandbox\",\n \"players\": 0,\n \"messageable_players\": 6,\n \"apns_p8\": \"apns_p8\",\n \"chrome_web_origin\": \"chrome_web_origin\",\n \"basic_auth_key\": \"basic_auth_key\",\n \"site_name\": \"site_name\",\n \"safari_icon_16_16\": \"safari_icon_16_16\",\n \"chrome_web_default_notification_icon\": \"chrome_web_default_notification_icon\",\n \"organization_id\": \"organization_id\",\n \"name\": \"name\",\n \"safari_apns_certificates\": \"safari_apns_certificates\",\n \"safari_apns_p12_password\": \"safari_apns_p12_password\",\n \"safari_icon_256_256\": \"safari_icon_256_256\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a22e6294-ab30-4902-87e5-e27a032ce0b0", "name": "View an app", "request": { "name": "View an app", "description": { "content": "View the details of a single OneSignal app", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) An app id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a9b757dc-7c9c-45d5-9d3a-18f07ce00ed7", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) An app id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"apns_key_id\": \"apns_key_id\",\n \"apns_team_id\": \"apns_team_id\",\n \"apns_p12\": \"apns_p12\",\n \"safari_site_origin\": \"safari_site_origin\",\n \"apns_p12_password\": \"apns_p12_password\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"safari_icon_64_64\": \"safari_icon_64_64\",\n \"chrome_web_sub_domain\": \"chrome_web_sub_domain\",\n \"gcm_key\": \"gcm_key\",\n \"apns_bundle_id\": \"apns_bundle_id\",\n \"chrome_key\": \"chrome_key\",\n \"safari_push_id\": \"safari_push_id\",\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"apns_certificates\": \"apns_certificates\",\n \"safari_apns_p12\": \"safari_apns_p12\",\n \"safari_icon_128_128\": \"safari_icon_128_128\",\n \"android_gcm_sender_id\": \"android_gcm_sender_id\",\n \"safari_icon_32_32\": \"safari_icon_32_32\",\n \"additional_data_is_root_payload\": true,\n \"apns_env\": \"sandbox\",\n \"players\": 0,\n \"messageable_players\": 6,\n \"apns_p8\": \"apns_p8\",\n \"chrome_web_origin\": \"chrome_web_origin\",\n \"basic_auth_key\": \"basic_auth_key\",\n \"site_name\": \"site_name\",\n \"safari_icon_16_16\": \"safari_icon_16_16\",\n \"chrome_web_default_notification_icon\": \"chrome_web_default_notification_icon\",\n \"organization_id\": \"organization_id\",\n \"name\": \"name\",\n \"safari_apns_certificates\": \"safari_apns_certificates\",\n \"safari_apns_p12_password\": \"safari_apns_p12_password\",\n \"safari_icon_256_256\": \"safari_icon_256_256\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76aaefb5-4cff-4ab5-adc2-b018210676d4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) An app id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa186779-a9c5-4b5a-99fe-907511e9545d", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) An app id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9912b50f-7ae2-4379-b54a-025a31a3dfe8", "name": "Update an app", "request": { "name": "Update an app", "description": { "content": "Updates the name or configuration settings of an existing OneSignal app", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) An app id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"android_gcm_sender_id\": \"\",\n \"gcm_key\": \"\",\n \"chrome_web_origin\": \"\",\n \"chrome_key\": \"\",\n \"chrome_web_default_notification_icon\": \"\",\n \"chrome_web_sub_domain\": \"\",\n \"apns_env\": \"\",\n \"apns_p12\": \"\",\n \"apns_p12_password\": \"\",\n \"safari_apns_p12\": \"\",\n \"safari_apns_p12_password\": \"\",\n \"apns_key_id\": \"\",\n \"apns_team_id\": \"\",\n \"apns_bundle_id\": \"\",\n \"apns_p8\": \"\",\n \"safari_site_origin\": \"\",\n \"safari_icon_256_256\": \"\",\n \"site_name\": \"\",\n \"organization_id\": \"\",\n \"additional_data_is_root_payload\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "958caa95-86c6-481a-8a32-e390574da875", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) An app id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"apns_key_id\": \"apns_key_id\",\n \"apns_team_id\": \"apns_team_id\",\n \"apns_p12\": \"apns_p12\",\n \"safari_site_origin\": \"safari_site_origin\",\n \"apns_p12_password\": \"apns_p12_password\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"safari_icon_64_64\": \"safari_icon_64_64\",\n \"chrome_web_sub_domain\": \"chrome_web_sub_domain\",\n \"gcm_key\": \"gcm_key\",\n \"apns_bundle_id\": \"apns_bundle_id\",\n \"chrome_key\": \"chrome_key\",\n \"safari_push_id\": \"safari_push_id\",\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"apns_certificates\": \"apns_certificates\",\n \"safari_apns_p12\": \"safari_apns_p12\",\n \"safari_icon_128_128\": \"safari_icon_128_128\",\n \"android_gcm_sender_id\": \"android_gcm_sender_id\",\n \"safari_icon_32_32\": \"safari_icon_32_32\",\n \"additional_data_is_root_payload\": true,\n \"apns_env\": \"sandbox\",\n \"players\": 0,\n \"messageable_players\": 6,\n \"apns_p8\": \"apns_p8\",\n \"chrome_web_origin\": \"chrome_web_origin\",\n \"basic_auth_key\": \"basic_auth_key\",\n \"site_name\": \"site_name\",\n \"safari_icon_16_16\": \"safari_icon_16_16\",\n \"chrome_web_default_notification_icon\": \"chrome_web_default_notification_icon\",\n \"organization_id\": \"organization_id\",\n \"name\": \"name\",\n \"safari_apns_certificates\": \"safari_apns_certificates\",\n \"safari_apns_p12_password\": \"safari_apns_p12_password\",\n \"safari_icon_256_256\": \"safari_icon_256_256\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"apns_key_id\": \"apns_key_id\",\n \"apns_team_id\": \"apns_team_id\",\n \"apns_p12\": \"apns_p12\",\n \"safari_site_origin\": \"safari_site_origin\",\n \"apns_p12_password\": \"apns_p12_password\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"safari_icon_64_64\": \"safari_icon_64_64\",\n \"chrome_web_sub_domain\": \"chrome_web_sub_domain\",\n \"gcm_key\": \"gcm_key\",\n \"apns_bundle_id\": \"apns_bundle_id\",\n \"chrome_key\": \"chrome_key\",\n \"safari_push_id\": \"safari_push_id\",\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"apns_certificates\": \"apns_certificates\",\n \"safari_apns_p12\": \"safari_apns_p12\",\n \"safari_icon_128_128\": \"safari_icon_128_128\",\n \"android_gcm_sender_id\": \"android_gcm_sender_id\",\n \"safari_icon_32_32\": \"safari_icon_32_32\",\n \"additional_data_is_root_payload\": true,\n \"apns_env\": \"sandbox\",\n \"players\": 0,\n \"messageable_players\": 6,\n \"apns_p8\": \"apns_p8\",\n \"chrome_web_origin\": \"chrome_web_origin\",\n \"basic_auth_key\": \"basic_auth_key\",\n \"site_name\": \"site_name\",\n \"safari_icon_16_16\": \"safari_icon_16_16\",\n \"chrome_web_default_notification_icon\": \"chrome_web_default_notification_icon\",\n \"organization_id\": \"organization_id\",\n \"name\": \"name\",\n \"safari_apns_certificates\": \"safari_apns_certificates\",\n \"safari_apns_p12_password\": \"safari_apns_p12_password\",\n \"safari_icon_256_256\": \"safari_icon_256_256\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62a1a4df-22ae-49e3-b51b-933c10f7ba3f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) An app id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"apns_key_id\": \"apns_key_id\",\n \"apns_team_id\": \"apns_team_id\",\n \"apns_p12\": \"apns_p12\",\n \"safari_site_origin\": \"safari_site_origin\",\n \"apns_p12_password\": \"apns_p12_password\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"safari_icon_64_64\": \"safari_icon_64_64\",\n \"chrome_web_sub_domain\": \"chrome_web_sub_domain\",\n \"gcm_key\": \"gcm_key\",\n \"apns_bundle_id\": \"apns_bundle_id\",\n \"chrome_key\": \"chrome_key\",\n \"safari_push_id\": \"safari_push_id\",\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"apns_certificates\": \"apns_certificates\",\n \"safari_apns_p12\": \"safari_apns_p12\",\n \"safari_icon_128_128\": \"safari_icon_128_128\",\n \"android_gcm_sender_id\": \"android_gcm_sender_id\",\n \"safari_icon_32_32\": \"safari_icon_32_32\",\n \"additional_data_is_root_payload\": true,\n \"apns_env\": \"sandbox\",\n \"players\": 0,\n \"messageable_players\": 6,\n \"apns_p8\": \"apns_p8\",\n \"chrome_web_origin\": \"chrome_web_origin\",\n \"basic_auth_key\": \"basic_auth_key\",\n \"site_name\": \"site_name\",\n \"safari_icon_16_16\": \"safari_icon_16_16\",\n \"chrome_web_default_notification_icon\": \"chrome_web_default_notification_icon\",\n \"organization_id\": \"organization_id\",\n \"name\": \"name\",\n \"safari_apns_certificates\": \"safari_apns_certificates\",\n \"safari_apns_p12_password\": \"safari_apns_p12_password\",\n \"safari_icon_256_256\": \"safari_icon_256_256\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ef74716-9906-4689-a536-da88b9b86885", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) An app id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"apns_key_id\": \"apns_key_id\",\n \"apns_team_id\": \"apns_team_id\",\n \"apns_p12\": \"apns_p12\",\n \"safari_site_origin\": \"safari_site_origin\",\n \"apns_p12_password\": \"apns_p12_password\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"safari_icon_64_64\": \"safari_icon_64_64\",\n \"chrome_web_sub_domain\": \"chrome_web_sub_domain\",\n \"gcm_key\": \"gcm_key\",\n \"apns_bundle_id\": \"apns_bundle_id\",\n \"chrome_key\": \"chrome_key\",\n \"safari_push_id\": \"safari_push_id\",\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"apns_certificates\": \"apns_certificates\",\n \"safari_apns_p12\": \"safari_apns_p12\",\n \"safari_icon_128_128\": \"safari_icon_128_128\",\n \"android_gcm_sender_id\": \"android_gcm_sender_id\",\n \"safari_icon_32_32\": \"safari_icon_32_32\",\n \"additional_data_is_root_payload\": true,\n \"apns_env\": \"sandbox\",\n \"players\": 0,\n \"messageable_players\": 6,\n \"apns_p8\": \"apns_p8\",\n \"chrome_web_origin\": \"chrome_web_origin\",\n \"basic_auth_key\": \"basic_auth_key\",\n \"site_name\": \"site_name\",\n \"safari_icon_16_16\": \"safari_icon_16_16\",\n \"chrome_web_default_notification_icon\": \"chrome_web_default_notification_icon\",\n \"organization_id\": \"organization_id\",\n \"name\": \"name\",\n \"safari_apns_certificates\": \"safari_apns_certificates\",\n \"safari_apns_p12_password\": \"safari_apns_p12_password\",\n \"safari_icon_256_256\": \"safari_icon_256_256\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "deec512b-d61e-495f-ac09-33eb8a471cbe", "name": "Get Segments", "request": { "name": "Get Segments", "description": { "content": "Returns an array of segments from an app.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "segments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "offset", "value": "", "description": "Segments are listed in ascending order of created_at date. offset will omit that number of segments from the beginning of the list. Eg offset 5, will remove the 5 earliest created Segments." }, { "disabled": false, "key": "limit", "value": "", "description": "The amount of Segments in the response. Maximum 300." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9d987ab3-27eb-4336-80ad-2fe50ae1390d", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "segments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "offset", "value": "" }, { "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"offset\": 6,\n \"total_count\": 0,\n \"limit\": 1,\n \"segments\": [\n {\n \"is_active\": true,\n \"updated_at\": \"updated_at\",\n \"read_only\": true,\n \"name\": \"name\",\n \"created_at\": \"created_at\",\n \"app_id\": \"app_id\"\n },\n {\n \"is_active\": true,\n \"updated_at\": \"updated_at\",\n \"read_only\": true,\n \"name\": \"name\",\n \"created_at\": \"created_at\",\n \"app_id\": \"app_id\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21688786-7177-4925-a6fa-1ff758fab4fc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "segments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "offset", "value": "" }, { "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dc5c297-7328-4afe-b184-05ce92b3d50f", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "segments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "offset", "value": "" }, { "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "915bd54f-099b-44b5-b1a6-d78731c641e2", "name": "Create Segment", "request": { "name": "Create Segment", "description": { "content": "Create a segment visible and usable in the dashboard and API - Required: OneSignal Paid Plan\nThe Create Segment method is used when you want your server to programmatically create a segment instead of using the OneSignal Dashboard UI. Just like creating Segments from the dashboard you can pass in filters with multiple \"AND\" or \"OR\" operator's.\n🚧\nDoes Not Update Segments\nThis endpoint will only create segments, it does not edit or update currently created Segments. You will need to use the Delete Segment endpoint and re-create it with this endpoint to edit.\n", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "segments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n },\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n }\n ],\n \"name\": \"\",\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3ee1cd96-f6a9-4edc-8823-2ac30592485b", "name": "Created", "originalRequest": { "url": { "path": [ "apps", ":app_id", "segments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n },\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n }\n ],\n \"name\": \"\",\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a4abe4f-4511-4f64-81b1-900efc4967ee", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "segments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n },\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n }\n ],\n \"name\": \"\",\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c62fe258-dff0-416b-bf16-9f7a7340f4d5", "name": "Conflict", "originalRequest": { "url": { "path": [ "apps", ":app_id", "segments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n },\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n }\n ],\n \"name\": \"\",\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"errors\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "accb44a1-d300-4aad-83c0-747fac453181", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "segments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": [\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n },\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n }\n ],\n \"name\": \"\",\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe7aee16-a158-4edb-bf96-7ccdff7b4155", "name": "Delete Segment", "request": { "name": "Delete Segment", "description": { "content": "Delete a segment (not user devices) - Required: OneSignal Paid Plan\nYou can delete a segment under your app by calling this API. You must provide an API key in the Authorization header that has admin access on the app.\nThe segment_id can be found in the URL of the segment when viewing it in the dashboard.\n", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "segments", ":segment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "segment_id", "description": "(Required) The segment_id can be found in the URL of the segment when viewing it in the dashboard." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0f7997e7-8f0a-481f-b0b2-35ca52f3b747", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "segments", ":segment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "segment_id", "description": "(Required) The segment_id can be found in the URL of the segment when viewing it in the dashboard." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1dc491e-1485-43d6-a3f9-0fa73f0f7981", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "segments", ":segment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "segment_id", "description": "(Required) The segment_id can be found in the URL of the segment when viewing it in the dashboard." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd0eace9-3386-40b8-9765-dbf0dceb62d1", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "segments", ":segment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "segment_id", "description": "(Required) The segment_id can be found in the URL of the segment when viewing it in the dashboard." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a130a7e-6d7c-4158-8b5d-ad35787f910c", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "segments", ":segment_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "segment_id", "description": "(Required) The segment_id can be found in the URL of the segment when viewing it in the dashboard." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d66aa37-bbcc-4f4d-a916-e965ef4e0b75", "name": "View Outcomes", "request": { "name": "View Outcomes", "description": { "content": "View the details of all the outcomes associated with your app\n\n🚧\nRequires Authentication Key\nRequires your OneSignal App's REST API Key, available in Keys & IDs.\n\n🚧\nOutcome Data Limitations\nOutcomes are only accessible for around 30 days before deleted from our servers. You will need to export this data every month if you want to keep it.\n", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "outcome_names", "value": "", "description": "(Required) Required\nComma-separated list of names and the value (sum/count) for the returned outcome data.\nNote: Clicks only support count aggregation.\nFor out-of-the-box OneSignal outcomes such as click and session duration, please use the \"os\" prefix with two underscores. For other outcomes, please use the name specified by the user.\nExample:os__session_duration.count,os__click.count,CustomOutcomeName.sum\n" }, { "disabled": false, "key": "outcome_names[]", "value": "", "description": "Optional\nIf outcome names contain any commas, then please specify only one value at a time.\nExample: outcome_names[]=os__click.count&outcome_names[]=Sales, Purchase.count\nwhere \"Sales, Purchase\" is the custom outcomes with a comma in the name.\n" }, { "disabled": false, "key": "outcome_time_range", "value": "", "description": "Optional\nTime range for the returned data. The values can be 1h (for the last 1 hour data), 1d (for the last 1 day data), or 1mo (for the last 1 month data).\nDefault is 1h if the parameter is omitted.\n" }, { "disabled": false, "key": "outcome_platforms", "value": "", "description": "Optional\nPlatform id. Refer device's platform ids for values.\nExample:\noutcome_platform=0 for iOS\noutcome_platform=7,8 for Safari and Firefox\nDefault is data from all platforms if the parameter is omitted.\n" }, { "disabled": false, "key": "outcome_attribution", "value": "", "description": "Optional\nAttribution type for the outcomes. The values can be direct or influenced or unattributed.\nExample: outcome_attribution=direct\nDefault is total (returns direct+influenced+unattributed) if the parameter is omitted.\n" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ee905683-148c-4fd2-809c-7ce156a46722", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "outcome_names", "value": "" }, { "key": "outcome_names[]", "value": "" }, { "key": "outcome_time_range", "value": "" }, { "key": "outcome_platforms", "value": "" }, { "key": "outcome_attribution", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"outcomes\": [\n {\n \"aggregation\": \"count\",\n \"id\": \"string\",\n \"value\": 3574\n },\n {\n \"aggregation\": \"sum\",\n \"id\": \"string\",\n \"value\": 9370\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7177dea7-2341-4c8f-85a8-29a51eb3f1de", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "outcome_names", "value": "" }, { "key": "outcome_names[]", "value": "" }, { "key": "outcome_time_range", "value": "" }, { "key": "outcome_platforms", "value": "" }, { "key": "outcome_attribution", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16186350-a881-49ac-bc1d-7d40e70812b1", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "outcomes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "outcome_names", "value": "" }, { "key": "outcome_names[]", "value": "" }, { "key": "outcome_time_range", "value": "" }, { "key": "outcome_platforms", "value": "" }, { "key": "outcome_attribution", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08294a30-e22b-475b-a475-4aa3781797c6", "name": "Start Live Activity", "request": { "name": "Start Live Activity", "description": { "content": "Remotely start a Live Activity on iOS devices via OneSignal’s REST API.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "activities", "activity", ":activity_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." }, { "disabled": false, "type": "any", "value": "", "key": "activity_type", "description": "(Required) The name of the Live Activity defined in your app. This should match the attributes struct used in your app's Live Activity implementation." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"activity_id\": \"\",\n \"contents\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"event\": \"start\",\n \"event_attributes\": \"\",\n \"event_updates\": \"\",\n \"headings\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"name\": \"\",\n \"stale_date\": \"\",\n \"priority\": \"\",\n \"ios_relevance_score\": \"\",\n \"idempotency_key\": \"\",\n \"include_aliases\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"include_subscription_ids\": [\n \"\",\n \"\"\n ],\n \"included_segments\": [\n \"\",\n \"\"\n ],\n \"excluded_segments\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n },\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8038189a-4caa-4603-ae74-161fd72ab98f", "name": "Created", "originalRequest": { "url": { "path": [ "apps", ":app_id", "activities", "activity", ":activity_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." }, { "disabled": false, "type": "any", "value": "", "key": "activity_type", "description": "(Required) The name of the Live Activity defined in your app. This should match the attributes struct used in your app's Live Activity implementation." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"activity_id\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"event\": \"start\",\n \"event_attributes\": \"\",\n \"event_updates\": \"\",\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"name\": \"\",\n \"stale_date\": \"\",\n \"priority\": \"\",\n \"ios_relevance_score\": \"\",\n \"idempotency_key\": \"\",\n \"include_aliases\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"include_subscription_ids\": [\n \"\",\n \"\"\n ],\n \"included_segments\": [\n \"\",\n \"\"\n ],\n \"excluded_segments\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n },\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"notification_id\": \"notification_id\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3978a2f-bfe0-4663-90da-44c17f33dfdc", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "activities", "activity", ":activity_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." }, { "disabled": false, "type": "any", "value": "", "key": "activity_type", "description": "(Required) The name of the Live Activity defined in your app. This should match the attributes struct used in your app's Live Activity implementation." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"activity_id\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"event\": \"start\",\n \"event_attributes\": \"\",\n \"event_updates\": \"\",\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"name\": \"\",\n \"stale_date\": \"\",\n \"priority\": \"\",\n \"ios_relevance_score\": \"\",\n \"idempotency_key\": \"\",\n \"include_aliases\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"include_subscription_ids\": [\n \"\",\n \"\"\n ],\n \"included_segments\": [\n \"\",\n \"\"\n ],\n \"excluded_segments\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n },\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a03a78cb-19be-458a-b08a-bfdeb15fb583", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "activities", "activity", ":activity_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." }, { "disabled": false, "type": "any", "value": "", "key": "activity_type", "description": "(Required) The name of the Live Activity defined in your app. This should match the attributes struct used in your app's Live Activity implementation." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"activity_id\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"event\": \"start\",\n \"event_attributes\": \"\",\n \"event_updates\": \"\",\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"name\": \"\",\n \"stale_date\": \"\",\n \"priority\": \"\",\n \"ios_relevance_score\": \"\",\n \"idempotency_key\": \"\",\n \"include_aliases\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"include_subscription_ids\": [\n \"\",\n \"\"\n ],\n \"included_segments\": [\n \"\",\n \"\"\n ],\n \"excluded_segments\": [\n \"\",\n \"\"\n ],\n \"filters\": [\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n },\n {\n \"field\": \"\",\n \"key\": \"\",\n \"value\": \"\",\n \"hours_ago\": \"\",\n \"radius\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"relation\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84853c65-0665-48c1-91f5-1feb7d5ebb60", "name": "Update a Live Activity via Push", "request": { "name": "Update a Live Activity via Push", "description": { "content": "Updates a specified live activity.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "live_activities", ":activity_id", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "activity_id", "description": "(Required) Live Activity record ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"event_updates\": \"\",\n \"name\": \"\",\n \"contents\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"headings\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"sound\": \"\",\n \"stale_date\": \"\",\n \"dismissal_date\": \"\",\n \"priority\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6a8b5db0-ee7a-4f23-91cc-667607c20c84", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "live_activities", ":activity_id", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "activity_id", "description": "(Required) Live Activity record ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"event_updates\": \"\",\n \"name\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"sound\": \"\",\n \"stale_date\": \"\",\n \"dismissal_date\": \"\",\n \"priority\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80913f5e-9864-4400-9315-8e8267671bf9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "live_activities", ":activity_id", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "activity_id", "description": "(Required) Live Activity record ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"event_updates\": \"\",\n \"name\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"sound\": \"\",\n \"stale_date\": \"\",\n \"dismissal_date\": \"\",\n \"priority\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d79bcd91-3fc0-47d2-ba90-eef980c17a2d", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "live_activities", ":activity_id", "notifications" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "activity_id", "description": "(Required) Live Activity record ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"event_updates\": \"\",\n \"name\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"sound\": \"\",\n \"stale_date\": \"\",\n \"dismissal_date\": \"\",\n \"priority\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8203d66e-56f0-4bfc-aa74-4bd6d802ade0", "name": "create user", "request": { "name": "create user", "description": { "content": "Creates a User, optionally Subscriptions owned by the User as well as Aliases.\nAliases provided in the payload will be used to look up an existing User.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"tags\": {\n \"key_0\": true\n },\n \"language\": \"\",\n \"timezone_id\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"country\": \"\",\n \"first_active\": \"\",\n \"last_active\": \"\",\n \"amount_spent\": \"\",\n \"purchases\": [\n {\n \"amount\": \"\",\n \"iso\": \"\",\n \"sku\": \"\",\n \"count\": \"\"\n },\n {\n \"amount\": \"\",\n \"iso\": \"\",\n \"sku\": \"\",\n \"count\": \"\"\n }\n ],\n \"ip\": \"\"\n },\n \"identity\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"subscriptions\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"token\": \"\",\n \"enabled\": \"\",\n \"notification_types\": \"\",\n \"session_time\": \"\",\n \"session_count\": \"\",\n \"sdk\": \"\",\n \"device_model\": \"\",\n \"device_os\": \"\",\n \"rooted\": \"\",\n \"test_type\": \"\",\n \"app_version\": \"\",\n \"net_type\": \"\",\n \"carrier\": \"\",\n \"web_auth\": \"\",\n \"web_p256\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"token\": \"\",\n \"enabled\": \"\",\n \"notification_types\": \"\",\n \"session_time\": \"\",\n \"session_count\": \"\",\n \"sdk\": \"\",\n \"device_model\": \"\",\n \"device_os\": \"\",\n \"rooted\": \"\",\n \"test_type\": \"\",\n \"app_version\": \"\",\n \"net_type\": \"\",\n \"carrier\": \"\",\n \"web_auth\": \"\",\n \"web_p256\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "54235763-7048-4a3d-baff-e3b456ffc961", "name": "CREATED", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscriptions\": [\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n },\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n ],\n \"identity\": {\n \"key\": \"identity\"\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriptions\": [\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n },\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n ],\n \"identity\": {\n \"key\": \"identity\"\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b26a9f3-6923-48f9-a15d-5e29d6e60ce0", "name": "CREATED", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscriptions\": [\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n },\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n ],\n \"identity\": {\n \"key\": \"identity\"\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriptions\": [\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n },\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n ],\n \"identity\": {\n \"key\": \"identity\"\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bd3f94e-7912-4b01-8720-ecbb7511fe84", "name": "ACCEPTED", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscriptions\": [\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n },\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n ],\n \"identity\": {\n \"key\": \"identity\"\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriptions\": [\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n },\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n ],\n \"identity\": {\n \"key\": \"identity\"\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "544a5d1b-30f8-4872-bf26-3eb26122b8a9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscriptions\": [\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n },\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n ],\n \"identity\": {\n \"key\": \"identity\"\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d29fcf6-29e3-472c-ada1-ff018fb24900", "name": "Multiple User Identity Conflict", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscriptions\": [\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n },\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n ],\n \"identity\": {\n \"key\": \"identity\"\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n {\n \"code\": \"string\",\n \"title\": \"string\",\n \"meta\": {\n \"conflicting_aliases\": {}\n }\n },\n {\n \"code\": \"string\",\n \"title\": \"string\",\n \"meta\": {\n \"conflicting_aliases\": {}\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac4a3b87-7a01-4330-ae89-e8bf6693c7ae", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscriptions\": [\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n },\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n ],\n \"identity\": {\n \"key\": \"identity\"\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7c6e841-9122-45d2-ae71-0360fc7e873d", "name": "delete user", "request": { "name": "delete user", "description": { "content": "Removes the User identified by (:alias_label, :alias_id), and all Subscriptions and Aliases", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1249e14f-30ae-4d6b-bee5-1c7e70fc3f86", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "37ecb88f-fc15-4263-833c-e8c35483fec9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b54bff10-dbbd-403f-93b4-405673f7bd83", "name": "Conflict", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f979c86-34ed-4ee9-a920-3c925825fa22", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c03d035-92a8-479a-9ead-015fc053cdc2", "name": "get user", "request": { "name": "get user", "description": { "content": "Returns the User’s properties, Aliases, and Subscriptions.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "834f0705-8be0-4532-a7f7-65d4b0e4d7aa", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriptions\": [\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n },\n {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n ],\n \"identity\": {\n \"key\": \"identity\"\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "864f99cb-fb7f-49be-bef1-a937a29c3e3d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa95084f-6d43-48b9-8b63-442f02b997ce", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65b59a3b-a57f-41e9-b92d-ad07570b0abf", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e99dc84-77dc-4397-a61d-da23c2fc6435", "name": "update user", "request": { "name": "update user", "description": { "content": "Updates an existing User’s properties.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"tags\": {\n \"key_0\": \"string\"\n },\n \"language\": \"\",\n \"timezone_id\": \"\",\n \"lat\": \"\",\n \"long\": \"\",\n \"country\": \"\",\n \"first_active\": \"\",\n \"last_active\": \"\",\n \"amount_spent\": \"\",\n \"purchases\": [\n {\n \"amount\": \"\",\n \"iso\": \"\",\n \"sku\": \"\",\n \"count\": \"\"\n },\n {\n \"amount\": \"\",\n \"iso\": \"\",\n \"sku\": \"\",\n \"count\": \"\"\n }\n ],\n \"ip\": \"\"\n },\n \"refresh_device_metadata\": false,\n \"deltas\": {\n \"session_time\": \"\",\n \"session_count\": \"\",\n \"purchases\": [\n {\n \"amount\": \"\",\n \"iso\": \"\",\n \"sku\": \"\",\n \"count\": \"\"\n },\n {\n \"amount\": \"\",\n \"iso\": \"\",\n \"sku\": \"\",\n \"count\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e3ebf438-49b4-4d1e-bec3-0b1fe23451c7", "name": "ACCEPTED", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"refresh_device_metadata\": false,\n \"deltas\": {\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"session_count\": 6,\n \"session_time\": 0\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "173eb095-0b30-49d9-8c27-c38d2b3e273d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"refresh_device_metadata\": false,\n \"deltas\": {\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"session_count\": 6,\n \"session_time\": 0\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58f42a08-ce0a-419b-a366-b1211c30ed52", "name": "Conflict", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"refresh_device_metadata\": false,\n \"deltas\": {\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"session_count\": 6,\n \"session_time\": 0\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c18bd981-8144-47b1-a7ee-06eb69615669", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"refresh_device_metadata\": false,\n \"deltas\": {\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"session_count\": 6,\n \"session_time\": 0\n },\n \"properties\": {\n \"country\": \"country\",\n \"purchases\": [\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n },\n {\n \"amount\": \"amount\",\n \"iso\": \"iso\",\n \"count\": 2,\n \"sku\": \"sku\"\n }\n ],\n \"ip\": \"ip\",\n \"timezone_id\": \"timezone_id\",\n \"language\": \"language\",\n \"first_active\": 1,\n \"last_active\": 5,\n \"lat\": 0.8008281904610115,\n \"long\": 6.027456183070403,\n \"tags\": {\n \"key\": \"\"\n },\n \"amount_spent\": 5.637376656633329\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b3db1fe-fa1b-4624-a961-89680c345415", "name": "get aliases", "request": { "name": "get aliases", "description": { "content": "Lists all Aliases for the User identified by (:alias_label, :alias_id).", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a2401e25-234b-4f4e-9dc1-a12fdbbadecd", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17121528-c841-4b5f-940c-73b17a0a7bfa", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cdb5f82-95eb-4888-8d01-27041c9e51d6", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fe0b334-d4c0-4a6b-8ae0-1fe2f6f355ef", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca5b6697-36e7-4218-9feb-d2a02857d1e4", "name": "create alias", "request": { "name": "create alias", "description": { "content": "Upserts one or more Aliases to an existing User identified by (:alias_label, :alias_id).", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7bce2723-e069-4098-93c0-eb65eeb313c3", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eda7bbe0-5483-405c-9534-6bbcdc9c470a", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5493458f-9235-4198-989d-441335a47c13", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccf8c393-5b53-4615-82ce-71810d23750d", "name": "Conflict", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1e9d461-73af-4275-8d6c-5b6250b9e26b", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f240274-2fac-47e0-a9cf-cd775994e3b5", "name": "delete alias", "request": { "name": "delete alias", "description": { "content": "Deletes an alias by alias label", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity", ":alias_label_to_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label_to_delete", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "42bb58d1-9ae2-4143-bece-d9c7bfdd17be", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity", ":alias_label_to_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label_to_delete", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e948ba3-2b2c-4595-91a2-6c83b8467e96", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity", ":alias_label_to_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label_to_delete", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2922cce-7100-4482-8bf1-47345511ca82", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity", ":alias_label_to_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label_to_delete", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd5e0c25-c645-40f2-9705-1e6f3b382679", "name": "Conflict", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity", ":alias_label_to_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label_to_delete", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2b993ef-31fe-4203-be6b-8edbf82e9910", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "identity", ":alias_label_to_delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label_to_delete", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9db00b76-97f1-4bd3-8a39-1b0bdfa0afbb", "name": "create subscription", "request": { "name": "create subscription", "description": { "content": "Creates a new Subscription under the User provided. Useful to add email addresses and SMS numbers to the User.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"id\": \"\",\n \"type\": \"\",\n \"token\": \"\",\n \"enabled\": \"\",\n \"notification_types\": \"\",\n \"session_time\": \"\",\n \"session_count\": \"\",\n \"sdk\": \"\",\n \"device_model\": \"\",\n \"device_os\": \"\",\n \"rooted\": \"\",\n \"test_type\": \"\",\n \"app_version\": \"\",\n \"net_type\": \"\",\n \"carrier\": \"\",\n \"web_auth\": \"\",\n \"web_p256\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "57d7c589-c678-42ed-a34a-f8783a73e7fc", "name": "CREATED", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d36a948-6b1e-469c-af7d-793c359ce325", "name": "ACCEPTED", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecbbfafa-7cfd-4595-896b-b802f2825967", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c1f784c-b225-4352-aaa6-52f2441375bc", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3cad70e-c8fb-4521-9beb-cbe5ef7cbc16", "name": "Operation is not permitted due to user having the maximum number of subscriptions assigned", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7529e58d-ff95-4b36-9a91-0d819987746b", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "users", "by", ":alias_label", ":alias_id", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_label", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "alias_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ddfd94f-9393-4ad3-aeab-f414f8a537d2", "name": "delete subscription", "request": { "name": "delete subscription", "description": { "content": "Deletes the Subscription.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6fd32a61-a18b-41c6-a444-83109d886150", "name": "ACCEPTED", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9315e233-bafd-4407-8d1e-050047c435bb", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65a76bb0-70ff-4810-99ef-c36c0184a5a8", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e76c0dcf-a6f9-44a9-9c37-9bcf5596d27e", "name": "Conflict", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb4b0c3b-f3f5-47f3-9e95-7bf5feb9a72d", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3274ad5-57eb-420e-99a6-0b680b53c340", "name": "update subscription", "request": { "name": "update subscription", "description": { "content": "Updates an existing Subscription’s properties.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"id\": \"\",\n \"type\": \"\",\n \"token\": \"\",\n \"enabled\": \"\",\n \"notification_types\": \"\",\n \"session_time\": \"\",\n \"session_count\": \"\",\n \"sdk\": \"\",\n \"device_model\": \"\",\n \"device_os\": \"\",\n \"rooted\": \"\",\n \"test_type\": \"\",\n \"app_version\": \"\",\n \"net_type\": \"\",\n \"carrier\": \"\",\n \"web_auth\": \"\",\n \"web_p256\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0246d38f-6181-472b-9df1-0e525b689e8f", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed76dfec-4666-4c64-aa03-b3db5caa8943", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6181a04e-a98f-4327-bba4-ea0554c2dfce", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a64f3170-6548-491a-8327-2c8afba7caff", "name": "Conflict", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f497e2c5-4f1c-4755-9aa0-8276bb68696f", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a0e1423-7e32-4079-9245-782fe0b6b6c0", "name": "get aliases by subscription", "request": { "name": "get aliases by subscription", "description": { "content": "Lists all Aliases for the User identified by :subscription_id.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "user", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e039d2c4-e945-4b21-bf1f-95b428c5c765", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "user", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45a4cd06-689b-4d20-824a-dec7014af73d", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "user", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc55142f-0b13-4454-9f71-25947a1d5d42", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "user", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb5b334d-c4c5-4eb8-9d4a-221d9c86f6c7", "name": "create alias by subscription", "request": { "name": "create alias by subscription", "description": { "content": "Upserts one or more Aliases for the User identified by :subscription_id.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "user", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7f90ab02-6fb8-42b9-b667-bfec35e166ff", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "user", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "620093dd-eee9-4543-ae93-28d50780061b", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "user", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcf6eb6a-5b5f-4a47-b7eb-37af9990d52a", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "user", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2164c25-305e-4b95-97e3-87e2e824cddc", "name": "Conflict", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "user", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71a8268a-ff19-4429-8916-42111dbe2545", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "user", "identity" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1bf54897-f15d-485c-849d-413a70637552", "name": "transfer subscription", "request": { "name": "transfer subscription", "description": { "content": "Transfers this Subscription to the User identified by the identity in the payload.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "owner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cd42f7d6-d787-4a5a-8691-f32397e12200", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "owner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f631c7b7-000d-41ec-ad18-fb70edee46ac", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "owner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b723bd7d-1cf8-4e69-b6c7-4b499d8cfacb", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "owner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63254119-7a79-4905-92b0-f68813702072", "name": "Conflict", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "owner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4eff8363-b25b-4b32-86bf-81615cc1bc14", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions", ":subscription_id", "owner" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "subscription_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identity\": {\n \"key\": \"identity\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87c898d7-9554-4382-87f9-8fa97926546a", "name": "Update subscription by token", "request": { "name": "Update subscription by token", "description": { "content": "Update properties on an existing OneSignal subscription using its token.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "subscriptions_by_token", ":token_type", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." }, { "disabled": false, "type": "any", "value": "", "key": "token_type", "description": "(Required) The type of token to use when looking up the subscription. See Subscription Types." }, { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) The value of the token to lookup by (e.g., email address, phone number)." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"id\": \"\",\n \"type\": \"\",\n \"token\": \"\",\n \"enabled\": \"\",\n \"notification_types\": \"\",\n \"session_time\": \"\",\n \"session_count\": \"\",\n \"sdk\": \"\",\n \"device_model\": \"\",\n \"device_os\": \"\",\n \"rooted\": \"\",\n \"test_type\": \"\",\n \"app_version\": \"\",\n \"net_type\": \"\",\n \"carrier\": \"\",\n \"web_auth\": \"\",\n \"web_p256\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9328c443-61fd-4525-81ed-cd44a7c232a7", "name": "ACCEPTED", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions_by_token", ":token_type", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." }, { "disabled": false, "type": "any", "value": "", "key": "token_type", "description": "(Required) The type of token to use when looking up the subscription. See Subscription Types." }, { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) The value of the token to lookup by (e.g., email address, phone number)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11b48aa5-0299-483e-98a6-19f4fb7d6478", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions_by_token", ":token_type", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." }, { "disabled": false, "type": "any", "value": "", "key": "token_type", "description": "(Required) The type of token to use when looking up the subscription. See Subscription Types." }, { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) The value of the token to lookup by (e.g., email address, phone number)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "599996a2-3c0c-4b52-b4b1-9efe5bec1cdc", "name": "Not Found", "originalRequest": { "url": { "path": [ "apps", ":app_id", "subscriptions_by_token", ":token_type", ":token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." }, { "disabled": false, "type": "any", "value": "", "key": "token_type", "description": "(Required) The type of token to use when looking up the subscription. See Subscription Types." }, { "disabled": false, "type": "any", "value": "", "key": "token", "description": "(Required) The value of the token to lookup by (e.g., email address, phone number)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"notification_types\": 7,\n \"device_model\": \"device_model\",\n \"app_version\": \"app_version\",\n \"web_p256\": \"web_p256\",\n \"net_type\": 4,\n \"type\": \"iOSPush\",\n \"device_os\": \"device_os\",\n \"enabled\": true,\n \"session_time\": 9,\n \"test_type\": 2,\n \"token\": \"token\",\n \"carrier\": \"carrier\",\n \"session_count\": 3,\n \"web_auth\": \"web_auth\",\n \"rooted\": true,\n \"sdk\": \"sdk\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b535735-e19d-4562-9591-b0d45e057954", "name": "Unsubscribe with token", "request": { "name": "Unsubscribe with token", "description": { "content": "Unsubscribe an email with a token when using your own custom email unsubscribe landing page", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "notifications", ":notification_id", "unsubscribe" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "token", "value": "", "description": "(Required) The unsubscribe token that is generated via liquid syntax in {{subscription.unsubscribe_token}} when personalizing an email." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The id of the message found in the creation notification POST response, View Notifications GET response, or URL within the Message Report." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "10316852-740c-449b-803b-7123e5ac6557", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "notifications", ":notification_id", "unsubscribe" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "token", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The id of the message found in the creation notification POST response, View Notifications GET response, or URL within the Message Report." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75969d88-b5e2-46fc-8626-148e5dff8f61", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "notifications", ":notification_id", "unsubscribe" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "token", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The id of the message found in the creation notification POST response, View Notifications GET response, or URL within the Message Report." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e44ec3e9-e65b-4a70-84bc-21bb15e65eed", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "notifications", ":notification_id", "unsubscribe" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "token", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) The OneSignal App ID for your app. Available in Keys & IDs." }, { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The id of the message found in the creation notification POST response, View Notifications GET response, or URL within the Message Report." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b7d479c-699b-4013-9408-239087b65ddf", "name": "Export CSV of Subscriptions", "request": { "name": "Export CSV of Subscriptions", "description": { "content": "Generate a compressed CSV export of all of your current user data\nThis method can be used to generate a compressed CSV export of all of your current user data. It is a much faster alternative than retrieving this data using the /players API endpoint.\nThe file will be compressed using GZip.\nThe file may take several minutes to generate depending on the number of users in your app.\nThe URL generated will be available for 3 days and includes random v4 uuid as part of the resource name to be unguessable.\n🚧\n403 Error Responses You can test if it is complete by making a GET request to the csv_file_url value. This file may take time to generate depending on how many device records are being pulled. If the file is not ready, a 403 error will be returned. Otherwise the file itself will be returned.\n🚧\nRequires Authentication Key\nRequires your OneSignal App's REST API Key, available in Keys & IDs.\n🚧\nConcurrent Exports\nOnly one concurrent export is allowed per OneSignal account. Please ensure you have successfully downloaded the .csv.gz file before exporting another app.\nCSV File Format:\n- Default Columns:\n | Field | Details |\n | --- | --- |\n | id | OneSignal Player Id |\n | identifier | Push Token |\n | session_count | Number of times they visited the app or site\n | language | Device language code |\n | timezone | Number of seconds away from UTC. Example: -28800 |\n | game_version | Version of your mobile app gathered from Android Studio versionCode in your App/build.gradle and iOS uses kCFBundleVersionKey in Xcode. |\n | device_os | Device Operating System Version. Example: 80 = Chrome 80, 9 = Android 9 |\n | device_type | Device Operating System Type |\n | device_model | Device Hardware String Code. Example: Mobile Web Subscribers will have `Linux armv` |\n | ad_id | Based on the Google Advertising Id for Android, identifierForVendor for iOS. OptedOut means user turned off Advertising tracking on the device. |\n | tags | Current OneSignal Data Tags on the device. |\n | last_active | Date and time the user last opened the mobile app or visited the site. |\n | playtime | Total amount of time in seconds the user had the mobile app open. |\n | amount_spent | \tMobile only - amount spent in USD on In-App Purchases. | \n | created_at | Date and time the device record was created in OneSignal. Mobile - first time they opened the app with OneSignal SDK. Web - first time the user subscribed to the site. |\n | invalid_identifier | t = unsubscribed, f = subscibed |\n | badge_count | Current number of badges on the device |\n- Extra Columns:\n | Field | Details |\n | --- | --- |\n | external_user_id | Your User Id set on the device |\n | notification_types | Notification types |\n | location | Location points (Latitude and Longitude) set on the device. |\n | country | Country code |\n | rooted | Android device rooted or not |\n | ip | IP Address of the device if being tracked. See Handling Personal Data. |\n | web_auth | Web Only authorization key. |\n | web_p256 | Web Only p256 key. |\n", "type": "text/plain" }, "url": { "path": [ "players", "csv_export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "{{app_id}}" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"extra_fields\": [\n \"\",\n \"\"\n ],\n \"last_active_since\": \"\",\n \"segment_name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f8e86afe-f9ec-47a0-9c51-329525f6d4f8", "name": "OK", "originalRequest": { "url": { "path": [ "players", "csv_export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"extra_fields\": [\n \"string\",\n \"string\"\n ],\n \"last_active_since\": \"string\",\n \"segment_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"csv_file_url\": \"csv_file_url\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8615c5a-6543-4760-8eef-67d914c4e6c9", "name": "Bad Request", "originalRequest": { "url": { "path": [ "players", "csv_export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"extra_fields\": [\n \"string\",\n \"string\"\n ],\n \"last_active_since\": \"string\",\n \"segment_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62f84515-27f5-4493-9957-bdd6dc5eaca7", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "players", "csv_export" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"extra_fields\": [\n \"string\",\n \"string\"\n ],\n \"last_active_since\": \"string\",\n \"segment_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7f6cdba-1adf-48c4-83cf-60b13c7fc2d9", "name": "Export CSV of Events", "request": { "name": "Export CSV of Events", "description": { "content": "Generate a compressed CSV report of all of the events data for a notification.\nThis will return a URL immediately upon success but it may take several minutes for the CSV to become available at that URL depending on the volume of data. Only one export can be in-progress per OneSignal account at any given time.", "type": "text/plain" }, "url": { "path": [ "notifications", ":notification_id", "export_events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "{{app_id}}" }, { "disabled": false, "key": "app_id", "value": "", "description": "(Required) The ID of the app that the notification belongs to." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The ID of the notification to export events from." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "99480b60-b9b4-489e-a7bf-dfaa92c62cf3", "name": "OK", "originalRequest": { "url": { "path": [ "notifications", ":notification_id", "export_events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The ID of the notification to export events from." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"csv_file_url\": \"csv_file_url\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5913c55e-336a-44a7-8890-74c372d698c4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "notifications", ":notification_id", "export_events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The ID of the notification to export events from." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92633118-707e-4918-b068-092313631514", "name": "Not Found", "originalRequest": { "url": { "path": [ "notifications", ":notification_id", "export_events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The ID of the notification to export events from." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27a5590d-6933-4677-8725-14e3158c3f98", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "notifications", ":notification_id", "export_events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "notification_id", "description": "(Required) The ID of the notification to export events from." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c526f95b-1186-43b2-a7bc-37dc750f8493", "name": "View templates", "request": { "name": "View templates", "description": { "content": "List templates for an app.", "type": "text/plain" }, "url": { "path": [ "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "app_id", "value": "", "description": "(Required) Your OneSignal App ID in UUID v4 format." }, { "disabled": false, "key": "limit", "value": "50", "description": "Maximum number of templates. Default and max is 50." }, { "disabled": false, "key": "offset", "value": "0", "description": "Pagination offset." }, { "disabled": false, "key": "channel", "value": "", "description": "Filter by delivery channel." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "081861ba-d785-4bc1-bc0b-d8ec07ca9c92", "name": "OK", "originalRequest": { "url": { "path": [ "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" }, { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "channel", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"templates\": [\n {\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"name\": \"name\",\n \"channel\": \"push\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"content\": {\n \"key\": \"\"\n }\n },\n {\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"name\": \"name\",\n \"channel\": \"push\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"content\": {\n \"key\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "007bf405-9224-4fc6-9c49-665e34614eb2", "name": "Bad Request", "originalRequest": { "url": { "path": [ "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" }, { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "channel", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0179b1d-3efc-472e-98ba-6f67839f2c3d", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" }, { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "channel", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67d48839-2d8a-4ca7-a43c-4afd4abee34a", "name": "Create template", "request": { "name": "Create template", "description": { "content": "Create reusable message templates for push, email, and SMS channels.", "type": "text/plain" }, "url": { "path": [ "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"app_id\": \"\",\n \"contents\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"name\": \"\",\n \"headings\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"subtitle\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"isEmail\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"email_bcc\": [\n \"\",\n \"\"\n ],\n \"isSMS\": \"\",\n \"dynamic_content\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fb911702-2c35-48a7-8188-0047855a1c0f", "name": "OK", "originalRequest": { "url": { "path": [ "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"name\": \"\",\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"subtitle\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"isEmail\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"email_bcc\": [\n \"\",\n \"\"\n ],\n \"isSMS\": \"\",\n \"dynamic_content\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"name\": \"name\",\n \"channel\": \"push\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"content\": {\n \"key\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ccc8cff-7218-4855-a463-2ff2932ce833", "name": "Bad Request", "originalRequest": { "url": { "path": [ "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"name\": \"\",\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"subtitle\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"isEmail\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"email_bcc\": [\n \"\",\n \"\"\n ],\n \"isSMS\": \"\",\n \"dynamic_content\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03d26e25-6fb6-4525-9db2-280489bf765e", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"name\": \"\",\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"subtitle\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"isEmail\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"email_bcc\": [\n \"\",\n \"\"\n ],\n \"isSMS\": \"\",\n \"dynamic_content\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "431fca3b-4197-4a09-8c6a-607ade37e6c2", "name": "Delete template", "request": { "name": "Delete template", "description": { "content": "Delete a template by id.", "type": "text/plain" }, "url": { "path": [ "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "app_id", "value": "", "description": "(Required) " } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e282e100-b393-44d7-bce0-c9c8746e7351", "name": "OK", "originalRequest": { "url": { "path": [ "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af7581b0-d86e-4e30-86ad-1999de05f341", "name": "Bad Request", "originalRequest": { "url": { "path": [ "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6144ac6b-12ae-41a3-8704-ab194af3fbd0", "name": "Not Found", "originalRequest": { "url": { "path": [ "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c48f0f0-d860-4695-9075-5dbfe2aa9f41", "name": "View template", "request": { "name": "View template", "description": { "content": "Fetch a single template by id.", "type": "text/plain" }, "url": { "path": [ "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "app_id", "value": "", "description": "(Required) " } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8342f3ae-0aab-4dca-960d-8ae37421d2ea", "name": "OK", "originalRequest": { "url": { "path": [ "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"name\": \"name\",\n \"channel\": \"push\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"content\": {\n \"key\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "989b512f-b233-4c29-9f62-3c486a9fd9be", "name": "Bad Request", "originalRequest": { "url": { "path": [ "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9a30fe7-d3c6-4796-ad91-fa503968622a", "name": "Not Found", "originalRequest": { "url": { "path": [ "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65799d12-971d-4eaa-9a8b-80f0889a8034", "name": "Update template", "request": { "name": "Update template", "description": { "content": "Update an existing template.", "type": "text/plain" }, "url": { "path": [ "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "app_id", "value": "", "description": "(Required) " } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"contents\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"headings\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"subtitle\": {\n \"en\": \"\",\n \"ar\": \"\",\n \"bs\": \"\",\n \"bg\": \"\",\n \"ca\": \"\",\n \"zh-Hans\": \"\",\n \"zh-Hant\": \"\",\n \"zh\": \"\",\n \"hr\": \"\",\n \"cs\": \"\",\n \"da\": \"\",\n \"nl\": \"\",\n \"et\": \"\",\n \"fi\": \"\",\n \"fr\": \"\",\n \"ka\": \"\",\n \"de\": \"\",\n \"el\": \"\",\n \"hi\": \"\",\n \"he\": \"\",\n \"hu\": \"\",\n \"id\": \"\",\n \"it\": \"\",\n \"ja\": \"\",\n \"ko\": \"\",\n \"lv\": \"\",\n \"lt\": \"\",\n \"ms\": \"\",\n \"nb\": \"\",\n \"pl\": \"\",\n \"fa\": \"\",\n \"pt\": \"\",\n \"pa\": \"\",\n \"ro\": \"\",\n \"ru\": \"\",\n \"sr\": \"\",\n \"sk\": \"\",\n \"es\": \"\",\n \"sv\": \"\",\n \"th\": \"\",\n \"tr\": \"\",\n \"uk\": \"\",\n \"vi\": \"\"\n },\n \"isEmail\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"email_bcc\": [\n \"\",\n \"\"\n ],\n \"isSMS\": \"\",\n \"dynamic_content\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "684233b5-2ff1-48b8-a44d-51c3dfed94f4", "name": "OK", "originalRequest": { "url": { "path": [ "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"subtitle\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"isEmail\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"email_bcc\": [\n \"\",\n \"\"\n ],\n \"isSMS\": \"\",\n \"dynamic_content\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"name\": \"name\",\n \"channel\": \"push\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"content\": {\n \"key\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "539bde55-9765-42ac-b0e0-f93606387479", "name": "Bad Request", "originalRequest": { "url": { "path": [ "templates", ":template_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"contents\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"headings\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"subtitle\": {\n \"de\": \"de\",\n \"hi\": \"hi\",\n \"fi\": \"fi\",\n \"ru\": \"ru\",\n \"pt\": \"pt\",\n \"bg\": \"bg\",\n \"lt\": \"lt\",\n \"hr\": \"hr\",\n \"lv\": \"lv\",\n \"fr\": \"fr\",\n \"hu\": \"hu\",\n \"bs\": \"bs\",\n \"zh-Hans\": \"zh-Hans\",\n \"zh-Hant\": \"zh-Hant\",\n \"ka\": \"ka\",\n \"uk\": \"uk\",\n \"sk\": \"sk\",\n \"ca\": \"ca\",\n \"sr\": \"sr\",\n \"sv\": \"sv\",\n \"ko\": \"ko\",\n \"ms\": \"ms\",\n \"el\": \"el\",\n \"en\": \"en\",\n \"it\": \"it\",\n \"zh\": \"zh\",\n \"es\": \"es\",\n \"et\": \"et\",\n \"cs\": \"cs\",\n \"ar\": \"ar\",\n \"pa\": \"pa\",\n \"vi\": \"vi\",\n \"nb\": \"nb\",\n \"th\": \"th\",\n \"ja\": \"ja\",\n \"fa\": \"fa\",\n \"pl\": \"pl\",\n \"da\": \"da\",\n \"he\": \"he\",\n \"ro\": \"ro\",\n \"nl\": \"nl\",\n \"tr\": \"tr\"\n },\n \"isEmail\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"email_bcc\": [\n \"\",\n \"\"\n ],\n \"isSMS\": \"\",\n \"dynamic_content\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e32ac91-08d3-42f0-bd71-3ed2716ddcd6", "name": "Copy template to another app", "request": { "name": "Copy template to another app", "description": { "content": "Copy a template to a destination app.", "type": "text/plain" }, "url": { "path": [ "templates", ":template_id", "copy_to_app" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "app_id", "value": "", "description": "(Required) " } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"target_app_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "be5438c9-9448-4394-9fc2-1cf77bcc0ff0", "name": "OK", "originalRequest": { "url": { "path": [ "templates", ":template_id", "copy_to_app" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target_app_id\": \"target_app_id\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"updated_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"name\": \"name\",\n \"channel\": \"push\",\n \"created_at\": \"2000-01-23T04:56:07.000+00:00\",\n \"content\": {\n \"key\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab07d3df-615c-4dc4-8999-1d5c6455e012", "name": "Bad Request", "originalRequest": { "url": { "path": [ "templates", ":template_id", "copy_to_app" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "app_id", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "template_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target_app_id\": \"target_app_id\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5bcba6be-d898-4d67-90cc-fa328f22cc4b", "name": "View API keys", "request": { "name": "View API keys", "description": { "content": "View the details of all of your current app API keys (Rich Authentication Token) for a single OneSignal app.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "auth", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "75c6139a-587f-4400-9e1b-0aa82d510fed", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "auth", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tokens\": [\n {\n \"token_id\": \"token_id\",\n \"updated_at\": \"updated_at\",\n \"name\": \"name\",\n \"created_at\": \"created_at\",\n \"ip_allowlist_mode\": \"disabled\",\n \"ip_allowlist\": [\n \"ip_allowlist\",\n \"ip_allowlist\"\n ]\n },\n {\n \"token_id\": \"token_id\",\n \"updated_at\": \"updated_at\",\n \"name\": \"name\",\n \"created_at\": \"created_at\",\n \"ip_allowlist_mode\": \"disabled\",\n \"ip_allowlist\": [\n \"ip_allowlist\",\n \"ip_allowlist\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56c8e861-5440-4949-b769-0ffc7039a26c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "auth", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99ae665c-89e2-4b43-9513-4ac4345d68d1", "name": "Create API key", "request": { "name": "Create API key", "description": { "content": "Use this API to create a new App API Key (also called a Rich Authentication Token) for a specific OneSignal app. These keys are used to authenticate API requests at the app level and offer enhanced security features, including optional IP allowlisting.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "auth", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"ip_allowlist_mode\": \"\",\n \"ip_allowlist\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ed4bfea1-f398-466b-b933-cca105381b91", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "auth", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"ip_allowlist_mode\": \"disabled\",\n \"ip_allowlist\": [\n \"ip_allowlist\",\n \"ip_allowlist\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token_id\": \"token_id\",\n \"formatted_token\": \"formatted_token\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "515e0731-496f-4839-b809-32584cfa566c", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "auth", "tokens" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"ip_allowlist_mode\": \"disabled\",\n \"ip_allowlist\": [\n \"ip_allowlist\",\n \"ip_allowlist\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31813bc7-8016-4af8-8595-bd7a94b0792e", "name": "Delete API key", "request": { "name": "Delete API key", "description": { "content": "Delete a specific Rich Authentication Token (App API Key) for a OneSignal app. Requires your Organization API Key and the token’s unique ID, not the token value itself.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "auth", "tokens", ":token_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "token_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c9249eb6-b5b8-4663-b9c8-8693314c4efd", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "auth", "tokens", ":token_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "token_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a53016b5-ba5c-4feb-a87a-ac3fa1dd0fdf", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "auth", "tokens", ":token_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "token_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9a73f13-b7a3-4d81-8db0-54b3752ad77f", "name": "Update API key", "request": { "name": "Update API key", "description": { "content": "Update a Rich Authentication Token (App API Key) for a OneSignal app.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "auth", "tokens", ":token_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "token_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"ip_allowlist_mode\": \"\",\n \"ip_allowlist\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "16700f7a-f094-41f6-8203-509f59e80cef", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "auth", "tokens", ":token_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "token_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"ip_allowlist_mode\": \"disabled\",\n \"ip_allowlist\": [\n \"ip_allowlist\",\n \"ip_allowlist\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "427b64e9-42cd-4cae-9ec2-b0f26100ed41", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "auth", "tokens", ":token_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "token_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"name\",\n \"ip_allowlist_mode\": \"disabled\",\n \"ip_allowlist\": [\n \"ip_allowlist\",\n \"ip_allowlist\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac5c309b-dee5-400f-917a-78ea6f4f062f", "name": "Rotate API key", "request": { "name": "Rotate API key", "description": { "content": "Rotate a Rich Authentication Token (App API Key) for a OneSignal app. Rotating a key revokes the current token and generates a new one under the same configuration—ideal when a token is lost or compromised but you don’t want to recreate and reconfigure it from scratch.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "auth", "tokens", ":token_id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "token_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "269de66c-40a5-438c-8d8f-6bad9302846a", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "auth", "tokens", ":token_id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "token_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token_id\": \"token_id\",\n \"formatted_token\": \"formatted_token\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f0e1320-4498-43bd-a487-ff62d52796e5", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "auth", "tokens", ":token_id", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "token_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d3038aa-abf0-419e-bc6f-d79d7f63db89", "name": "Create custom events", "request": { "name": "Create custom events", "description": { "content": "The Custom Events API allows you to record user events. Custom events can represent any action users take in your application, such as completing a purchase, viewing content, or achieving milestones.", "type": "text/plain" }, "url": { "path": [ "apps", ":app_id", "integrations", "custom_events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"events\": [\n {\n \"name\": \"\",\n \"external_id\": \"\",\n \"onesignal_id\": \"\",\n \"timestamp\": \"\",\n \"payload\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"name\": \"\",\n \"external_id\": \"\",\n \"onesignal_id\": \"\",\n \"timestamp\": \"\",\n \"payload\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 587\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e8253e83-d579-4adb-8c90-9f4880547ba3", "name": "OK", "originalRequest": { "url": { "path": [ "apps", ":app_id", "integrations", "custom_events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n {\n \"onesignal_id\": \"onesignal_id\",\n \"payload\": {\n \"key\": \"\"\n },\n \"name\": \"name\",\n \"external_id\": \"external_id\",\n \"timestamp\": \"2000-01-23T04:56:07.000+00:00\"\n },\n {\n \"onesignal_id\": \"onesignal_id\",\n \"payload\": {\n \"key\": \"\"\n },\n \"name\": \"name\",\n \"external_id\": \"external_id\",\n \"timestamp\": \"2000-01-23T04:56:07.000+00:00\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "612d9555-ab92-4ab6-8430-4cd125325531", "name": "Bad Request", "originalRequest": { "url": { "path": [ "apps", ":app_id", "integrations", "custom_events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n {\n \"onesignal_id\": \"onesignal_id\",\n \"payload\": {\n \"key\": \"\"\n },\n \"name\": \"name\",\n \"external_id\": \"external_id\",\n \"timestamp\": \"2000-01-23T04:56:07.000+00:00\"\n },\n {\n \"onesignal_id\": \"onesignal_id\",\n \"payload\": {\n \"key\": \"\"\n },\n \"name\": \"name\",\n \"external_id\": \"external_id\",\n \"timestamp\": \"2000-01-23T04:56:07.000+00:00\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3fa4c1d-6fc5-4575-8e2a-d4fb733bffd9", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "apps", ":app_id", "integrations", "custom_events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n {\n \"onesignal_id\": \"onesignal_id\",\n \"payload\": {\n \"key\": \"\"\n },\n \"name\": \"name\",\n \"external_id\": \"external_id\",\n \"timestamp\": \"2000-01-23T04:56:07.000+00:00\"\n },\n {\n \"onesignal_id\": \"onesignal_id\",\n \"payload\": {\n \"key\": \"\"\n },\n \"name\": \"name\",\n \"external_id\": \"external_id\",\n \"timestamp\": \"2000-01-23T04:56:07.000+00:00\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": \"\",\n \"success\": true,\n \"reference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c6e976c-49dd-4549-a446-e6b38eacc5fb", "name": "Rate Limit Exceeded", "originalRequest": { "url": { "path": [ "apps", ":app_id", "integrations", "custom_events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "app_id", "description": "(Required) Your OneSignal App ID in UUID v4 format." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"events\": [\n {\n \"onesignal_id\": \"onesignal_id\",\n \"payload\": {\n \"key\": \"\"\n },\n \"name\": \"name\",\n \"external_id\": \"external_id\",\n \"timestamp\": \"2000-01-23T04:56:07.000+00:00\"\n },\n {\n \"onesignal_id\": \"onesignal_id\",\n \"payload\": {\n \"key\": \"\"\n },\n \"name\": \"name\",\n \"external_id\": \"external_id\",\n \"timestamp\": \"2000-01-23T04:56:07.000+00:00\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": [\n \"string\",\n \"string\"\n ],\n \"limit\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [], "variable": [ { "type": "string", "value": "https://api.onesignal.com", "key": "baseUrl" }, { "disabled": false, "description": { "content": "(Required) The app ID that you want to export devices from", "type": "text/plain" }, "type": "any", "value": "", "key": "app_id" } ], "info": { "_postman_id": "22a99968-5f7a-43fe-b617-3772ec662a57", "name": "OneSignal", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com\n\nContact Support:\n Name: OneSignal DevRel\n Email: devrel@onesignal.com", "type": "text/plain" } } }