API Docs

Add Plug-ins

Adds Plug-ins to an App.

MethodPOST
URLhttps://{subdomain}.kintone.com/k/v1/preview/app/plugins.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/plugins.json
Authentication Password Authentication, API Token Authentication, Session Authentication
Content-Typeapplication/json

Contents

Permissions

  • App Management Permissions are needed.

Request Parameters

Parameter Value Required Description
app Integer or String Yes The App ID.
ids Array of Strings Yes The Plug-in IDs that will be added to the App.
revision Integer or String Specify the expected current revision number for the App.
The request will fail if the stated revision number is not the latest revision.
The revision will not be checked if this parameter is ignored or -1 is specified.

Sample Request

JavaScript using kintone.api() 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

var body = {
  'app': 1,
  'ids': ['c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6']
};
kintone.api(kintone.api.url('/k/v1/preview/app/plugins.json', true), 'POST', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

curl Sample 

1
2
3
4
5
6

curl -X POST 'https://{subdomain}.kintone.com/k/v1/preview/app/plugins.json' \
  -H 'X-Cybozu-API-Token:{APIToken}' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 2, "ids": ["c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"]
  }'

Response Parameters

Parameter Type Description
revision String The updated revision number of the App.

Sample Response 

1
2
3

{
    "revision": "2"
}