このAPIのサポートはまもなく終了します。最新バージョンもしくは他のAPIを利用してください。

    共有アドレス帳グループ追加

    サーバー認証でテナント内の該当ドメインに共有アドレス帳グループを追加します。最大 1,000 件まで追加できます。

    API の種類

    サーバー API

    Request URL

    https://apis.worksmobile.com/{API ID}/contact/insertSharedGroup/v2

    HTTP Method

    POST (Content-Type: application/json; charset=UTF-8)

    Request

    • セキュアグループ(非公開グループ)の場合、管理者リストが必須です。
    • 管理者(managers)は該当ドメインのメンバーであり, メンバー(members)は該当ドメインのメンバー又は組織でなければなりません。
    パラメータ タイプ 必須 説明
    domainId Integer Y ドメイン ID
    name String Y グループ名(最大 25 字)
    description String N グループ説明(最大 100 字)
    open Boolean Y グループの公開有無
    ● true: 公開グループ
    ● false: セキュアグループ
    managers List N (セキュアグループの場合は必須) セキュアグループの管理者リスト
    (該当ドメインのメンバー ID)
    members List N セキュアグループのメンバーリスト
    (該当ドメインのメンバーまたは組織 ID)

    Request Example

    {
        "domainId": 1,
        "name": "Group Name",
        "description": "Group Description",
        "open": false,
        "managers": [
            "account1@example.com"
        ],
        "members": [
            "account2@example.com",
            "orgunit1@example.com"
        ]
    }
    

    Response

    プロパティ タイプ 説明
    code String 呼び出し結果
    ● 200 : 成功
    ● その他: エラーコード参考
    message String 結果メッセージ
    data String 呼び出し成功の場合、作成されたグループの UUID

    Response Example

    {
        "code": "200",
        "message": "success",
        "data": 100000000000001
    }
    

    エラーコード

    API呼び出しに失敗すると、エラーコードとエラーメッセージを返します。

    コード 説明
    400 パラメーターエラー
    406 グループ数上限(1,000 件)超過
    500 内部エラー
    Error Code Example
    {
        "code": "400",
        "message": "This group name is already in use."
    }