グループのサブメールアドレス追加

    グループにサブメールアドレスを追加します。最大 5 つまで追加できます。

    API の種類

    サーバー API

    Request URL

    • サービス: https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/groups/{externalKey}/email/aliases/{email}
    • テスト: https://sandbox-apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/groups/{externalKey}/email/aliases/{email}

    HTTP Method

    POST

    Path Parameters

    パラメーター タイプ 上限 必須 説明
    domainId Integer Y ドメイン ID
    externalKey String 100bytes Y 対象グループの ExternalKey
    email String 90字 Y サブメールアドレス
    ● localpart@domain 形式
    ● localpart は 2~64 字の英小文字、数字、ドット(.)、ハイフン(-)、アンダーバー(_)、エクスクラメーションマーク(!)のみ使用可。
    ● localpart の最初の文字は英数字、またはエクスクラメーションマーク(!)のみ可。
    ● ドット(.)は localpart の最初と最後および連続使用(..)不可。

    Request Example

    POST https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/groups/EX123/email/aliases/!test_123@example.com
    

    Response

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

    Error Code

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