Purpose: Edit group.

URL: https://www.commcatehq.org/a/[domain]/api/[version]/group/[id]

Method: PUT 

Input Parameters: 

Name 

Description 

Example 

name

Group name

Wozzle 

case_sharing

Whether users within this group will share cases with other members of this group

true/false

reporting

Whether this group's name will appear in the group filter list for reports

true/false  

users

List of all users ids belonging to the group 

(see examples)

This will replace any existing users for the group.

metadata 

Any additional custom data associated with the group 

(see examples) 

This will replace any existing custom data for the group.

 Sample input:

JSON Input
{
 "case_sharing": false,
 "metadata": {
  "localization": "Ghana"
 },
 "name": "Wozzle",
 "reporting": true,
 "users": [
  "91da6b1c78699adfb8679b741caf9f00",
  "8a642f722c9e617eeed29290e409fcd5"
 ]
}

 

  • No labels