機能説明
インバウンド受信用のドメインを登録します。
DKIMドメインと、インバウンド受信ドメインの登録数の合計が上限に達している場合には、新たなドメインを登録することができません。
リクエスト
エンドポイント
/v1/domains/inbounds
HTTPメソッド
POSTもしくはPUT
リクエストボディ
JSON形式であること
|
要素名
|
型
|
要素数
|
制限
|
説明
|
|---|---|---|---|---|
| domain | 文字列 | 1 |
|
ドメイン |
リクエストボディサンプル
レスポンス
ステータスコード
|
状態
|
コード
|
|---|---|
| 成功 | 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"}}