{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/groups","auth":"required","results":{"codes":[{"language":"json","code":"{\n  \"hidden\": false,\n  \"hidden_at\": null,\n  \"name\": \"sample_group\",\n  \"resource_type\": \"Mobile::App::Geofence\",\n  \"resource_ids\": [\n    \"586283bf61636518df330000\",\n    \"586a2d8061636526f7010000\"\n  ],\n  \"id\": \"58779837636f6eb7d4130000\"\n}","name":"","status":200}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"language":"shell","code":"curl -X POST \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/groups\"\n  -H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"\n  -d '{\n      \"group\": {\n          \"name\": \"sample_group\",\n          \"resource_type\": \"geofences\",\n          \"resource_ids\": [\"586283bf61636518df330000\", \"586a2d8061636526f7010000\"]\n      }\n  }'","name":""}]},"method":"post","params":[{"name":"group","type":"object","default":"","desc":"Group to be created","required":true,"in":"body","ref":"","_id":"564c387b9baa330d00faa623"},{"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":"group.name","type":"string","default":"","desc":"Group name","required":true,"in":"body","ref":"","_id":"5874f495967ae00f0016484e"},{"name":"group.resource_type","type":"string","default":"","desc":"Group resource type, can be one of: [campaigns, segments, beacons, geofences]","required":true,"in":"body","ref":"","_id":"5874f526aff63f0f006faf40"},{"name":"group.resource_ids","type":"array_string","default":"","desc":"Array of resource Id-s for the group, can be array of Ids of campaigns, segments, beacons or geofences","required":true,"in":"body","ref":"","_id":"5874f526aff63f0f006faf3f"}]},"next":{"description":"","pages":[]},"title":"Groups: Create One","type":"endpoint","slug":"groups-create-one","excerpt":"","body":"","updates":[],"order":46,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d28fe","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"},"githubsync":"","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"},"createdAt":"2017-01-10T13:14:58.874Z","parentDoc":null,"__v":8,"user":"5874dcd9edcf9f2f00f9e0af"}

postGroups: Create One


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

group:
required
object
Group to be created
group.name:
required
string
Group name
group.resource_type:
required
string
Group resource type, can be one of: [campaigns, segments, beacons, geofences]
group.resource_ids:
required
array of strings
Array of resource Id-s for the group, can be array of Ids of campaigns, segments, beacons or geofences

Examples


Result Format


User Information

Try It Out

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