{"_id":"5874de5233199b0f00ae9480","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":"","project":"54aa7f773b56130b0056c86e","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"},"parentDoc":null,"__v":8,"user":"5874dcd9edcf9f2f00f9e0af","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-10T13:14:58.874Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"name":"","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}","language":"json"}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"name":"","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  }'","language":"shell"}]},"method":"post","auth":"required","params":[{"_id":"564c387b9baa330d00faa623","ref":"","in":"body","required":true,"desc":"Group to be created","default":"","type":"object","name":"group"},{"_id":"57ff8232e7218a1900673d08","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":"5874f495967ae00f0016484e","ref":"","in":"body","required":true,"desc":"Group name","default":"","type":"string","name":"group.name"},{"_id":"5874f526aff63f0f006faf40","ref":"","in":"body","required":true,"desc":"Group resource type, can be one of: [campaigns, segments, beacons, geofences]","default":"","type":"string","name":"group.resource_type"},{"_id":"5874f526aff63f0f006faf3f","ref":"","in":"body","required":true,"desc":"Array of resource Id-s for the group, can be array of Ids of campaigns, segments, beacons or geofences","default":"","type":"array_string","name":"group.resource_ids"}],"url":"/apps/:app_id/groups"},"isReference":true,"order":43,"body":"","excerpt":"","slug":"groups-create-one","type":"endpoint","title":"Groups: Create One"}

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 }}