deleteAddress
    • PDF

    deleteAddress

    • PDF

    記事の要約

    Classic/VPC環境で利用できます。

    登録された受信者メールアドレスを削除します。削除対象を含む受信者グループがある場合、そのグループの関連情報が変更されます。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    DELETE/address-book/address

    リクエストヘッダ

    Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。

    リクエストボディ

    リクエストボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    emailAddressesList<String>Required削除対象の受信者メールアドレスリスト

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    curl --location --request DELETE 'https://mail.apigw.ntruss.com/api/v1/address-book/address'
    --header 'x-ncp-apigw-timestamp: {Timestamp}'
    --header 'x-ncp-iam-access-key: {Access Key}'
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    --header 'Content-Type: application/json'
    --data-raw '{
      "emailAddresses":[
        "xxx@naver.com",
        "xxx@daum.net",
        ...
      ]
    }'
    

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    totalAddressCountIntegerRequired総メールアドレス数
    groupsList<AddressBookResponse>Optional受信者グループ情報

    レスポンスステータスコード

    レスポンスステータスコードの説明は次の通りです。

    HTTPステータスコードコード説明
    200-リクエスト成功
    400-認証失敗、無効なリクエスト
    40077101ログイン情報エラー
    40077102リクエストエラー
    40077103リクエストしたリソースが存在しない
    40377201リクエストしたリソースに対する権限がない
    40377202メールサービスの使用を申し込んでいないユーザーが呼び出した場合
    40577001サポートしないメソッドタイプ
    41577002サポートしないメディアタイプ
    500-サーバエラー
    50077301基本プロジェクトが存在しない
    50077302外部システム API連携エラー
    50077303その他の内部サーバエラー

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    {
      "totalAddressCount": 4300,
      "groups": [
        {
          "sid": 155,
          "groupName": "10代",
          "addressCount": 3900
        },
        {
          "sid": 159,
          "groupName": "男性",
          "addressCount": 1000
        }
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.