{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/groups/:id","auth":"required","examples":{"codes":[{"code":"curl -X DELETE \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/groups/$ID\"\n\t-H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"","name":"","language":"shell"}]},"method":"delete","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":"57ff8232e7218a1900673d08"},{"name":"id","type":"string","default":"","desc":"Group ID. It can be fetched using \"Groups: Get All (Index)\" or \"Groups: Get One (Show)\" endpoints.","required":true,"in":"path","ref":"","_id":"5874f842aff63f0f006faf58"},{"name":"delete_resources","type":"boolean","default":"false","desc":"Should resources (campaigns, segments, beacons and geofences) which belongs to the group be deleted or not.","required":false,"in":"query","ref":"","_id":"5874ff41d8906c0f00d2b09d"}],"results":{"codes":[{"name":"","code":"{\n  \"hidden\": true,\n  \"hidden_at\": \"2017-01-12T14:59:16+00:00\",\n  \"name\": \"sample_name_2\",\n  \"resource_type\": \"Mobile::App::Campaign\",\n  \"resource_ids\": [\n    \"58591acc636f6e9a51ae0300\",\n    \"58591a6d636f6e9a51a50300\",\n    \"58739219636f6ef6a9a80000\"\n  ],\n  \"id\": \"587384b3636f6ea5f5110000\"\n}","language":"json","status":200}]},"settings":"564bbbf80cbcc91700b8171c"},"next":{"description":"","pages":[]},"title":"Groups: Delete One","type":"endpoint","slug":"groups-delete-one","excerpt":"","body":"","updates":[],"order":48,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d2902","createdAt":"2017-01-10T15:35:29.665Z","user":"5874dcd9edcf9f2f00f9e0af","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"},"__v":1,"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"},"parentDoc":null,"githubsync":"","project":"54aa7f773b56130b0056c86e"}

deleteGroups: Delete One


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Query Params

delete_resources:
booleanfalse
Should resources (campaigns, segments, beacons and geofences) which belongs to the group be deleted or not.

Examples


Result Format


User Information

Try It Out

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