{"_id":"58aad9de8f862f250076fa46","user":"5874dcd9edcf9f2f00f9e0af","__v":0,"parentDoc":null,"project":"54aa7f773b56130b0056c86e","category":{"_id":"58aad9dd8f862f250076f9f6","version":"58aad9dd8f862f250076f9f4","project":"54aa7f773b56130b0056c86e","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-17T23:47:10.058Z","from_sync":false,"order":2,"slug":"pulsate-cms-api","title":"Pulsate CMS API"},"version":{"_id":"58aad9dd8f862f250076f9f4","project":"54aa7f773b56130b0056c86e","__v":2,"createdAt":"2017-02-20T11:58:21.765Z","releaseDate":"2017-02-20T11:58:21.765Z","categories":["58aad9dd8f862f250076f9f5","58aad9dd8f862f250076f9f6","58aad9dd8f862f250076f9f7","58aad9dd8f862f250076f9f8","58aad9dd8f862f250076f9f9","58aad9dd8f862f250076f9fa","58aad9dd8f862f250076f9fb","58ac26b3d460ce2500185d26"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Locate","version_clean":"6.0.0","version":"6.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-10T15:25:41.821Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"hidden\": false,\n  \"hidden_at\": null,\n  \"name\": \"sample_name_2\",\n  \"resource_type\": \"Mobile::App::Campaign\",\n  \"resource_ids\": [\n    \"58591aec636f6e9a51c00300\",\n    \"58591acc636f6e9a51ae0300\",\n    \"58591a9e636f6e9a51a80300\",\n    \"58591a6d636f6e9a51a50300\",\n    \"5873927a636f6ef6a9ab0000\",\n    \"58739219636f6ef6a9a80000\"\n  ],\n  \"id\": \"587384b3636f6ea5f5110000\"\n}","name":""}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"language":"shell","code":"curl -X PUT \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/groups/$ID\" \\\n-H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\" \\ \n-d '{\n    \"group\": {\n        \"name\": \"sample_name_2\"\n    }\n}'","name":""}]},"method":"put","auth":"required","params":[{"_id":"57ff8232e7218a1900673d08","ref":"","in":"path","required":true,"desc":"App Id","default":"","type":"string","name":"app_id"},{"_id":"5874f842aff63f0f006faf58","ref":"","in":"query","required":true,"desc":"Group Id","default":"","type":"string","name":"id"},{"_id":"5874fcf5aff63f0f006faf62","ref":"","in":"body","required":true,"desc":"Group params to be updated","default":"","type":"object","name":"group"},{"_id":"5874fcf5aff63f0f006faf61","ref":"","in":"body","required":false,"desc":"Group name","default":"","type":"string","name":"group.name"},{"_id":"5874fcf5aff63f0f006faf60","ref":"","in":"body","required":false,"desc":"Group resource type, can be one of: [campaigns, segments, beacons, geofences]","default":"","type":"string","name":"group.resource_type"},{"_id":"5874fcf5aff63f0f006faf5f","ref":"","in":"body","required":false,"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/:id"},"isReference":true,"order":48,"body":"","excerpt":"","slug":"groups-get-one","type":"endpoint","title":"Groups: Update One"}

putGroups: Update One


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App Id

Query Params

id:
required
string
Group Id

Body Params

group:
required
object
Group params to be updated
group.name:
string
Group name
group.resource_type:
string
Group resource type, can be one of: [campaigns, segments, beacons, geofences]
group.resource_ids:
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

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