reseller
POST /v1/reseller/brand/sending-domain
Send your clients' e-mail from your own domain.
認証
ベアラー トークンとして API キーを送信します。キーには reseller.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/reseller/brand/sending-domain \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "domain": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Registers a sending domain and returns the DNS records to publish. Requires `reseller.manage`. ⛔ **This is the largest single white-label leak and no template change could close it.** Everything inside a notification was already resolved to your brand — the name, the call-to-action link — while the envelope still read `Zinn Digital® Billing <billing@zinndigital.com>`, which is the line your client actually looks at. ⛔ Attaching does **not** switch the sender. Publish the records, then call `/verify`; only a successful verification moves your mail onto your domain, because mail from an unverified domain does not arrive. A domain is already attached ⇒ `409`. Remove it first — replacing it silently would orphan the previous one at the provider.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | Uuid | いいえ | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
domain | string | はい | Just the domain — `acme.com` or `mail.acme.com`, with no scheme and no path. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
domain | string | はい | — |
verified | boolean | はい | The mail provider's answer. Never inferred from `domain` being set. |
provider | string | はい | — |
provider_status | string | はい | The provider's raw status word, for display. Never branch on it. |
records | BrandDnsRecord[] | はい | — |
このエンドポイントが返すエラー
401 · 403 · 409 · 422 · 429 · 503