domains
POST /v1/domains/{domainId}/email-routing/addresses
Register a destination address.
認証
ベアラー トークンとして API キーを送信します。キーには domains.dns.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/email-routing/addresses \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "email": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
This sends mail to a third party. The provider emails the address a verification link and will not deliver anything to it until the recipient clicks, so the response carries verified: false rather than pretending the destination is usable. Destination addresses are account-scoped at the provider, not zone-scoped: one address book serves every domain on the account. Requires domains.dns.manage.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
domainId (path) | Uuid | はい | The domain's id. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
email | string | はい | The provider emails this address a verification link. It is a write that reaches a third party, so it is permissioned and audit-logged accordingly. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
address_id | string | はい | — |
email | string | はい | — |
verified | boolean | はい | A fact about the recipient's action, never ours: the provider emails a verification link and will not deliver until it is clicked. |
created | string | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503