{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/campaigns/batch_pause","auth":"required","method":"put","params":[{"name":"app_id","type":"string","default":"","desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","required":true,"in":"path","ref":"","_id":"57ff817ec135231700aed825"},{"name":"campaign_ids","type":"array_string","default":"","desc":"Campaign ID-s to be paused. They can be fetched using \"Campaigns: Get All (Index)\" or \"Campaigns: Get One (Show)\" endpoints.","required":true,"in":"body","ref":"","_id":"58760b36b5092c1900586e10"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"end_at\": null,\n    \"guid\": \"UKEqNoNa\",\n    \"hidden\": false,\n    \"hidden_at\": null,\n    \"name\": \"Sanktuarium copy01\",\n    \"start_at\": \"2016-12-20T08:25:00+00:00\",\n    \"type\": \"CardPushNotificationCampaign\",\n    \"id\": \"5858eb34636f6e9a51f50100\",\n    \"subscriptions_count\": 2,\n    \"state\": \"paused\"\n  }\n]","name":""},{"language":"text","code":"HTTP Token: Access denied.","status":401}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"code":"curl -X PUT \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/campaigns/batch_pause\"\n  -H \"Authorization: Token token=$MY_API_ADMIN_TOKEN\"\n  -d \"campaign_ids[]=$CAMPAIGN_ID\"","language":"shell"}]}},"next":{"description":"","pages":[]},"title":"Campaigns: Pause Batch","type":"endpoint","slug":"campaigns-pause-batch","excerpt":"","body":"","updates":[],"order":23,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d2903","project":"54aa7f773b56130b0056c86e","version":{"version":"2.2","version_clean":"2.2.0","codename":"CMS API","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e4fced159815700262d2899","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","5e4fced159815700262d289a","5e4fced159815700262d289b","5e4fced159815700262d289c","5e4fced159815700262d289d","5e4fced159815700262d289e","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","5e4fced159815700262d289f","5e4fced159815700262d28a0","5c73dd27e8fdc000572a206a","5e4fced159815700262d28a1","5e53c04c1d11110018b56e12"],"_id":"5e4fced159815700262d2930","project":"54aa7f773b56130b0056c86e","forked_from":"55781fe25129590d003ff4f7","__v":1,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["5e4fced159815700262d28c6","5e4fced159815700262d28c7","5e4fced159815700262d28c8","5e4fced159815700262d28c9","5e4fced159815700262d28ca","5e4fced159815700262d28cb","5e4fced159815700262d28cc","5e4fced159815700262d28cd","5e4fced159815700262d28ce","564c68a93eb8f81700838a25"],"title":"Pulsate CMS API","slug":"pulsate-cms-api","order":1,"from_sync":false,"reference":true,"_id":"5e4fced159815700262d289e","__v":10,"createdAt":"2015-11-17T23:47:10.058Z","project":"54aa7f773b56130b0056c86e","version":"5e4fced159815700262d2930"},"createdAt":"2017-01-11T10:39:04.970Z","user":"5874dcd9edcf9f2f00f9e0af","__v":2,"githubsync":"","parentDoc":null}

putCampaigns: Pause 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
array of strings
Campaign ID-s to be paused. 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 }}