Update Departments

Updates departments of a Kintone environment.
Method PUT
URL https://{subdomain}.kintone.com/v1/organizations.json
Authentication Password Authentication
Content-Type application/json

Permissions

Only Administrators can use this API.

Request Parameters

Parameter Value Required Description
organizations Array of Objects Yes An array of organizations objects, containing data of Departments to be updated.
organizations[].code String Yes The Department Code of the department to update.
Must be 128 characters or less.
organizations[].name String Optional The new Name of the Department.
Must be 128 characters or less.
Ignoring this parameter will not update the name.
organizations[].localName String Optional The new Localized Name of the Department.
Must be 128 characters or less.
Ignoring this parameter will not update the Localized Name.
organizations[].localNameLocale String Optional The Locale of the Localized Name.
"en", "ja" or "zh" can be specified.
Ignoring this parameter, setting the value as an empty string, or specifying null will not update the Locale.
organizations[].parentCode String Optional The Department Code of the Parent Department.
Must be 128 characters or less.
Ignoring this parameter will not update the Parent Department.
Specifying an empty string will set the Department to the Root.
organizations[].description String Optional The Description of the Department.
Must be 1000 characters or less.
Ignoring this parameter will not update the Description.

Sample Request

JavaScript (using Kintone REST API Request)

curl Sample

Sample Response

Limitations

  • The Parent Department stated within the parentCode parameter may also exist inside the request parameter array. In this case, the array must include the data of the Parent Department before the Child Department.
  • If the same Department is specified within the request parameter, the Department will be updated with the details of the latter Department data.
Was this article helpful?
0 out of 0 found this helpful
Do you have any questions or issues related to this article?
Please share your views with us in the Community forums!