API
アドレスを更新する
アプリでのアドレス名を変更するか、アドレスを無効化または有効化します。省略したフィールドは値を保持します。
PATCH/domains/{id}/addresses/{addressId}
実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。
PATCH /domains/{id}/addresses/{addressId}
アプリでのアドレス名を変更するか、アドレスを無効化または有効化します。省略したフィールドは値を保持します。
リクエスト
パラメーター
labelstring | null- 新しい名前。最大 120 文字。`null` または空文字列でクリアされます。
enabledboolean- アドレスがメールを受け取るかどうか。無効なアドレスは SMTP の時点でメールをバウンスするので、送信者には無反応ではなくバウンスが返ります。
例
domains:write が必要です。特定のアドレスやドメインに限定されたキーは、ドメイン全体を持っている必要があります。
curl -X PATCH "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18" -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "enabled": false }'{ "object": "address", "id": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18", "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f", "address": "[email protected]", "localPart": "billing", "label": "Invoices", "enabled": false, "lastReceivedAt": null, "createdAt": "2026-09-25T10:00:00.000Z", "updatedAt": "2026-09-25T10:00:00.000Z"}