API Docs

Update App Admin Notes

Update App Admin Notes

Updates the notes for App administrators and their settings.
For more information refer to the following article:
Setting up Notes for App Administrators (External link)

MethodPUT
URLhttps://{subdomain}.kintone.com/k/v1/preview/app/adminNotes.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/adminNotes.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.
content String Optional The content of the notes.
The content must be between 0 to 10000 characters.
If the parameter is omitted, the content will not change.
includeInTemplateAndDuplicates Boolean or String Optional The permission settings to include this note in app templates or duplicates
  • true: include
  • false: do not include
If the parameter is omitted, the content will not change.
revision Integer or String Optional The revision number of the App settings.
If the parameter does not match the actual revision number, it will be considered an error, and the content will not be updated.
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
12
13
14

var body = {
  'app': 1,
  'content': 'Notes for app administrators',
  'includeInTemplateAndDuplicates': false,
  'revision': 2
};

kintone.api(kintone.api.url('/k/v1/preview/app/adminNotes.json', true), 'PUT', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

XMLHttpRequest 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

var body = {
  'app': 1,
  'content': 'Notes for app administrators',
  'includeInTemplateAndDuplicates': false,
  'revision': 2,
  // CSRF TOKEN: used for all APIs that have an HTTP method of POST, PUT and DELETE on Kintone.
  '__REQUEST_TOKEN__': kintone.getRequestToken()
};

var url = 'https://{subdomain}.kintone.com/k/v1/preview/app/adminNotes.json';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send(JSON.stringify(body));

Response Parameters

Property Name Type Description
revision String The revision number after changing the app settings.

Sample Response 

1
2
3

{
  "revision": "2"
}