{"_id":"58761cc136358c0f004bddf2","parentDoc":null,"project":"54aa7f773b56130b0056c86e","user":"5874dcd9edcf9f2f00f9e0af","version":{"_id":"55781fe25129590d003ff4f7","project":"54aa7f773b56130b0056c86e","forked_from":"54aa7f773b56130b0056c871","__v":6,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z","categories":["55781fe35129590d003ff4f8","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","55781fe35129590d003ff4fb","55781fe35129590d003ff4fc","55781fe35129590d003ff4fd","55781fe35129590d003ff4fe","564bbc7e8841060d00abb2ee","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","582318b23b961a0f009516a1","594a848c9f4771001a43c959"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Developers","version_clean":"2.0.0","version":"2.0"},"__v":3,"category":{"_id":"564bbc7e8841060d00abb2ee","__v":10,"pages":["564bbf454bf5c80d0020901e","564bc1b08b1c5521002bb914","564c387b9baa330d00faa622","564c3a7b61008d17006ffa3a","564c3e4083b72c2b00b36fb6","564c431b61008d17006ffa46","564c4bc9b9cdb41700a0eae7","564c4e955f9d102b00fc3b4a","564c5f32c241881700d85981","564c68a93eb8f81700838a25"],"project":"54aa7f773b56130b0056c86e","version":"55781fe25129590d003ff4f7","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-17T23:47:10.058Z","from_sync":false,"order":1,"slug":"pulsate-cms-api","title":"Pulsate CMS API"},"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-11T11:53:37.843Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","results":{"codes":[{"name":"","code":"[\n  {\n    \"end_at\": null,\n    \"guid\": \"gu7d11UT\",\n    \"hidden\": false,\n    \"hidden_at\": null,\n    \"name\": \"badge simple push lep\",\n    \"start_at\": \"2016-09-01T15:21:00+00:00\",\n    \"type\": \"PushNotificationCampaign\",\n    \"id\": \"57c84770636f6ec78a920100\",\n    \"subscriptions_count\": 1,\n    \"state\": \"stopped\"\n  }\n]","language":"json","status":200},{"code":"HTTP Token: Access denied.","language":"text","status":401}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"code":"curl -X PUT \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/campaigns/batch_stop\"\n  -H \"Authorization: Token token=$MY_API_ADMIN_TOKEN\"\n  -d \"campaign_ids[]=$CAMPAIGN_ID\"","language":"shell"}]},"auth":"required","params":[{"_id":"57ff817ec135231700aed825","ref":"","in":"path","required":true,"desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","default":"","type":"string","name":"app_id"},{"_id":"5b5b0dabeaf71700031c26ec","ref":"","in":"body","required":true,"desc":"Campaign ID-s to be stopped. They can be fetched using \"Campaigns: Get All (Index)\" or \"Campaigns: Get One (Show)\" endpoints.","default":"","type":"string","name":"campaign_ids"}],"url":"/apps/:app_id/campaigns/batch_stop"},"isReference":true,"order":25,"body":"","excerpt":"","slug":"campaigns-stop-batch","type":"endpoint","title":"Campaigns: Stop Batch"}

putCampaigns: Stop Batch


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

campaign_ids:
required
string
Campaign ID-s to be stopped. They can be fetched using "Campaigns: Get All (Index)" or "Campaigns: Get One (Show)" endpoints.

Examples


Result Format


User Information

Try It Out

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