Delete Groups

Contents

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

Permissions

Only Administrators (External link) can use this API.

Request Parameters

Parameter Value Required Description
codes Array of Strings Yes An array of Group codes.
The maximum limit is 100.

Sample Request

JavaScript (using
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
var body = {
  'codes': [
    'group1',
    'group2'
  ]
};

kintone.api(kintone.api.url('/v1/groups.json', true), 'DELETE', 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
$ curl -X DELETE \
  https://{subdomain}.kintone.com/v1/groups.json \
  -H 'Content-Type: application/json' \
  -H 'X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=' \
  -d '{
    "codes":[
      "group1",
      "group2"
    ]
  }'

Response Parameters

An empty JSON object will be returned.

Sample Response

1
{}

Limitations

  • It is not recommended run this API while performing the following operations on the Users & System Administration page: