domains
PUT /v1/domains/{domainId}/email-routing/rules/{ruleId}
Change a forwarding rule.
認証
ベアラー トークンとして API キーを送信します。キーには domains.dns.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PUT https://api.zinndigital.com/v1/domains/{domainId}/email-routing/rules/{ruleId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "matcher": <string>, "destinations": <string[]> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Requires `domains.dns.manage`. The catch-all is a separate resource at the provider and cannot be changed through this path — use `PUT .../email-routing/catch-all`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
domainId (path) | Uuid | はい | The domain's id. |
ruleId (path) | string | はい | The provider's own id for the routing rule. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
matcher | string | はい | — |
destinations | string[] | はい | — |
action | EmailRoutingAction | いいえ | `drop` is a chosen behaviour — it is how a catch-all silently discards spam — and is never inferred from an empty destination list. |
name | string | いいえ | — |
enabled | boolean | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
rule_id | string | はい | — |
matcher | string | はい | The address this rule applies to. Empty for the catch-all. |
destinations | string[] | はい | — |
action | EmailRoutingAction | はい | `drop` is a chosen behaviour — it is how a catch-all silently discards spam — and is never inferred from an empty destination list. |
name | string | はい | — |
enabled | boolean | はい | — |
catch_all | boolean | はい | — |
unsupported | boolean | はい | `true` when the provider's rule uses a shape this API cannot express — a Worker target, say. Such a rule is shown read-only rather than hidden: hiding it would make this screen… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503