インバウンド受信ドメイン登録

インバウンド受信用のドメインを登録する。

DKIMドメインとインバウンド受信ドメインの登録数を合計した数が上限に達している場合は新たなドメインを登録できない。

リクエスト

エンドポイント

/v1/domains/inbounds

HTTPメソッド

POST もしくは PUT

リクエストボディ

JSON形式であること

要素名
要素数
制限
説明
domain 文字列 1

半角英数字 . - 最大253文字
ドメイン形式の文字列であること

ドメイン
リクエストボディサンプル

{"domain":"example.com"}

レスポンス

ステータスコード
状態
コード
成功 200
リクエストボディがjsonではない 400
jsonリクエストのバリデーションエラー 400
認証失敗 401
存在しないエンドポイント 404
既に登録されている等の理由で登録に失敗した 403
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504
レスポンスボディ
要素名
要素数
説明
code 数値 1 ステータスコード
domain 文字列 1 登録したドメイン
type 文字列 1 INBOUND 固定
status 文字列 1 VALIDATED 固定
成功

{"code":201,"domain":"example.com","type":"INBOUND","status":"VALIDATED"}

失敗

{"code":400,"error":"validation error", "validation_errors":{"domain":"required"}}