開発者向け機能：API：組織操作：組織更新
## 概要
APIを使用して組織を更新する事ができます。
## 事前準備
- APIの操作を行う前に[APIキーの作成](/manual/api-key)を実施してください。
- この機能を実行するための API キーを払い出すユーザにはテナント管理者権限が付与されている必要があります。
## リクエスト
下記のリクエスト形式で、jsonデータを送信します。
|設定項目|値|
|:--|:--|
|HTTPメソッド|POST|
|Content-Type |application/json|
|文字コード|UTF-8|
|URL|http://{サーバー名}/api/depts/{組織ID}/update(※1)|
|Body|以下のjsonデータを参考のこと|
(※1){サーバー名}、{組織ID}の部分は、適宜、環境に合わせて編集してください。
pleasanter.netの場合は以下の形式になります。
https\://pleasanter.net/fs/api/depts/{組織ID}/update
### 設定値
設定値は[スクリプトの$p.apiDeptsUpdate](/manual/script-api-depts-update) でも指定できます。
|パラメータ名|型|必須|概要|
|:--|:--|:--|:--|
|ApiVersion|decimal||APIのバージョン。|
|ApiKey|string|※1|事前に作成したAPIキー。|
|JSONデータレイアウト|object|○|作成するレコードの情報。詳細は[開発者向け機能：JSONデータレイアウト：Dept](api-dept)を参照|
※1：APIキーはAPIでは指定必須。スクリプトおよびサーバスクリプトは任意指定で、指定した場合はAPIキーのユーザの権限で処理を実行。
##### JSON
```
{
"ApiVersion": 1.1,
"ApiKey": "8s63Aiigd98h51Dfda7951...",
"DeptCode": "[更新後の組織の組織コード]",
"DeptName": "[更新後の組織の名前]",
"Body": "[更新後の組織の説明]",
"ClassHash": {
"ClassA": "test-class-column"
},
"NumHash": {
"NumA": 100
},
"DateHash": {
"DateA": "2026-08-19"
},
DescriptionHash: {
DescriptionA: "補足説明"
},
CheckHash: {
CheckA: true
}
}
```
## レスポンス
下記の形式のjsonデータが返却されます。
##### JSON
```
{
"Id": 12345,
"StatusCode": 200,
"Message": "\" 組織コード \" を更新しました。"
}
```
## エラー時の確認事項
[・API使用時の注意点やエラーが発生する場合の確認事項](/manual/faq-api)
[・FAQ:変更後の設定ファイルやAPIリクエスト(JSON形式)が正しく認識されない場合の確認事項](/manual/faq-json-format)
## 対応バージョン
|対応バージョン|内容|
|:--|:--|
|1.5.8.0 以降|拡張項目をAPIで更新する機能を追加|
