組織修正

組織の情報を修正します。

注意

組織追加/修正/移動 API は、1ドメインにつき必ずシングルスレッドで1秒に1回、順番通りに呼び出すことを推奨します。

API の種類

サーバー API

Request URL

https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/orgunits/{externalKey}

HTTP Method

PATCH

Path Parameters

パラメーター	タイプ	上限	必須	説明
domainId	Integer		Y	ドメイン ID
externalKey	String	100 字	Y	組織の External Key ● テナント内で一意になること ● 特殊文字 ' /%#?\ ' は許容しない

Request Parameters

Request Body

パラメーター	タイプ	上限	必須	説明
name	String	100 字	Y	組織名
i18nNames[]	List		N	多言語名リスト
i18nNames[].language	String		Y	多言語コード付録の言語/タイムゾーンコード参照。
i18nNames[].name	String	100 字	Y	多言語名
email	String	90 字	N	組織メールアドレス ● アドバンスト/ベーシック/プレミアムプランで利用している場合には、メールアドレスと同じ。 ● 他のプランで利用している場合には、ID@グループ名。 ● localpart@domain 形式 ● localpart は 2～64 字の英小文字、数字、ドット(.)、ハイフン(-)、アンダーバー(_)、エクスクラメーションマーク(!)のみ使用可。 ● localpart の最初の文字は英数字、またはエクスクラメーションマーク(!)のみ可。 ● ドット(.)は localpart の最初と最後および連続使用(..)不可。
description	String	160 字	N	組織の説明
display	Boolean		Y	組織の公開可否 (true/false) ● falseに設定すると下位組織も非公開(false)に切り替わる。 ● trueに設定すると上位組織も公開(true)に切り替わる。
aliasEmails	List	5個	N	組織のサブメールアドレスのリスト(ベーシック/プレミアムプランのみ登録可) ● 最大 90 文字 ● localpart@domain 形式で、入力規則は email と同様
receiveExternalMail	Boolean		N	外部メール受信可否
messageUse	Boolean		N	チームトークルームの利用有無
noteUse	Boolean		N	チームノートの利用有無 ● チームトークルーム利用時に利用可
calendarUse	Boolean		N	チームカレンダーの利用有無 ● チームトークルーム利用時に利用可
folderUse	Boolean		N	チームフォルダの利用有無 ● チームトークルーム利用時に利用可
serviceAlarm	Boolean		N	サービス通知の送信有無
membersToReceiveFrom[]	List		N	このメーリングリストにメールを送信可能なメンバーのリスト ● 指定されたメンバーのメールのみ受信
membersToReceiveFrom[].domainId	Integer		Y	メンバーのドメイン ID
membersToReceiveFrom[].externalKey	String	100자	Y	メンバーの External Key
membersToSendout[]	List		N	メーリングリストを送信アドレスとして使用可能なメンバーのリスト ● 組織の所属メンバーのみ指定可 (それ以外はリストから除外)
membersToSendout[].domainId	Integer		Y	メンバーのドメイン ID
membersToSendout[].externalKey	String	100 字	Y	メンバーの External Key

Request Example

PATCH https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/orgunits/EX123

{
    "name": "ORG1",
    "i18nNames": [
        {
            "language": "en_US",
            "name": "ORG1_en"
        }
    ],
    "email": "org1@example.com",
    "description": "ABC123 description",
    "display": true,
    "aliasEmails" : ["alias1@example.com", "aslias2@example.com"]
    "receiveExternalMail": true,
    "messageUse": true,
    "noteUse": true,
    "calendarUse": false,
    "folderUse": false,
    "serviceAlarm": false,
    "membersToReceiveFrom": [{
        "domainId": 123,
        "externalKey": "USER001"
    }],
    "membersToSendout": [{
        "domainId": 123,
        "externalKey": "USER001"
    }]
}

Response

呼び出しに成功すると HTTP 200 コードを返します。

Error code

呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST API エラーコードを参照してください。

LINE WORKS Developers