API Docs

Update Groups

Update Groups to a Kintone environment.
Up to 100 groups can be updated at a time.

Method PUT
URL https://{subdomain}.kintone.com/v1/groups.json
Authentication API Token Authentication , Password Authentication , Session Authentication
Content-Type application/json

Contents

Permissions

Only Administrators can use this API.

For more information on Administrators, refer to the following article:
Types of Administrators (External link)

Request Parameters

Parameter Value Required Description
groups Array of Objects Yes An array of groups objects, containing data of Groups to be updated.
groups[].code String Yes The Group code of the Group to be updated.
The maximum limit is 128 characters.
Empty strings, and characters consisting of only whitespaces are not allowed.
groups[].name String Yes The name of the Group.
The maximum limit is 128 characters.
Empty strings, and characters consisting of only whitespaces are not allowed
If omitted or null is specified, the value will not be updated.
groups[].description String Optional The description of the Group.
The maximum limit is 1000 characters.
If omitted or null is specified, the value will not be updated.

Sample Request

JavaScript using kintone.api() 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

var body = {
  'groups': [
    {
      'code': 'group_code1',
      'name': 'group_name1',
      'description': 'group_description1'
    }
  ]
};

kintone.api(kintone.api.url('/v1/groups.json', true), 'PUT', body, function(resp) {
  'use strict';
  // success
  console.log(resp);
}, function(error) {
  'use strict';
  // error
  console.log(error);
});

curl Sample

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

$ curl -X PUT \
  https://{subdomain}.kintone.com/v1/groups.json \
  -H 'Content-Type: application/json' \
  -H 'X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=' \
  -d '{
    'groups': [
      {
        'code': 'target_group_code',
        'name': 'updated_group_name',
        'description': 'updated_group_description'
      }
    ]
  }'

Response Parameters

An empty JSON object will be returned.

Sample Response

1

{}

Limitations

  • Group's codes cannot be changed.
  • It is not recommended to run this API while performing the following operations on the Users & System Administration page:
    • Updates to groups on the Groups (or Roles) page
      For more information on Groups (or Roles), refer to the following article:
      Managing Groups (or Roles) (External link)
    • Importing from a file