Пересылка адреса
Куда, помимо почтового ящика, уходит почта адреса. Каждый адрес пересылки подтверждает это по почте, прежде чем что-либо получит.
Выполняет любой из 5 запросов в вашем рабочем пространстве.
GET /domains/{id}/addresses/{addressId}/forwards
Куда, помимо почтового ящика, уходит почта адреса. Каждый адрес пересылки подтверждает это по почте, прежде чем что-либо получит.
Получить список адресов пересылки
Требуется domains:read. Все адреса пересылки этого адреса, от старых к новым. destination говорит, сохраняет ли адрес ещё и копию здесь (mailbox) или только пересылает (forward), а max показывает, сколько адресов пересылки может быть у одного адреса.
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/forwards" -H "$AUTH"{ "object": "list", "address": "[email protected]", "destination": "mailbox", "max": 10, "data": [ { "object": "address_forward", "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d", "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18", "email": "[email protected]", "enabled": true, "status": "live", "confirmedAt": "2026-09-26T08:12:40.000Z", "askedAt": "2026-09-26T08:02:11.000Z", "lastRelayAt": "2026-09-30T16:45:03.000Z", "lastError": null, "failures": 0, "createdAt": "2026-09-26T08:02:11.000Z" } ]}status равен live, когда адрес пересылки подтвердил, что хочет получать почту, pending, пока он не ответил, refused, если он отказался, и paused, пока он выключен. Что-либо получает только адрес пересылки со статусом live.
Добавить адреса пересылки
Требуется domains:write. POST /domains/{id}/addresses/{addressId}/forwards с { emails }, от 1 до 10 адресов. Каждому новому адресу пересылки отправляется письмо с просьбой подтвердить, поэтому он начинает в статусе pending.
curl -X POST "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/forwards" -H "$AUTH" \ -H "Content-Type: application/json" \ -d '{ "emails": ["[email protected]", "[email protected]"] }'{ "object": "address_forwards", "added": [ { "object": "address_forward", "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d", "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18", "email": "[email protected]", "enabled": true, "status": "pending", "confirmedAt": null, "askedAt": "2026-09-26T08:02:11.000Z", "lastRelayAt": null, "lastError": null, "failures": 0, "createdAt": "2026-09-26T08:02:11.000Z" } ], "skipped": [ { "email": "[email protected]", "reason": "[email protected] is hosted here, so it cannot be a forwarding destination. Share the address with that person instead." } ]}Адрес, обслуживаемый здесь, адрес, который уже есть в списке, адрес, который создал бы петлю, адрес сверх лимита в 10 и адрес, отказавшийся от почты из этого рабочего пространства, перечисляются в skipped с причиной, а остальные всё равно добавляются.
Выключенный адрес отклоняется с 409 address_disabled.
Ключ, ограниченный определёнными адресами или доменами, должен охватывать весь домен, а приложение, действующее от имени участника, может пересылать только адрес, который охватывает этот участник.
Токену доступа OAuth для этого вызова нужен код подтверждения. Пока приложение не подтвердило код за последние 60 минут, вызов отвечает 403 step_up_required и ничего не меняет. У API-ключа его никогда не спрашивают. Страница «Аутентификация» показывает, как запросить код и подтвердить его.
Приостановить или включить адрес пересылки
Требуется domains:write. PATCH /domains/{id}/addresses/{addressId}/forwards/{forwardId} с { enabled }. Приостановленный адрес пересылки сохраняет своё подтверждение, поэтому для повторного включения подтверждение не нужно.
curl -X PATCH "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/forwards/9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d" -H "$AUTH" \ -H "Content-Type: application/json" \ -d '{ "enabled": false }'{ "object": "address_forward", "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d", "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18", "email": "[email protected]", "enabled": false, "status": "paused", "destination": "mailbox"}Когда приостанавливается последний включённый адрес пересылки, адрес снова сохраняет свою почту здесь, и destination это показывает.
Токену доступа OAuth для этого вызова нужен код подтверждения. Пока приложение не подтвердило код за последние 60 минут, вызов отвечает 403 step_up_required и ничего не меняет. У API-ключа его никогда не спрашивают. Страница «Аутентификация» показывает, как запросить код и подтвердить его.
Удалить адрес пересылки
Требуется domains:write. DELETE /domains/{id}/addresses/{addressId}/forwards/{forwardId}. На него больше ничего не пересылается.
curl -X DELETE "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/forwards/9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d" -H "$AUTH"{ "object": "address_forward", "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d", "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18", "email": "[email protected]", "deleted": true, "destination": "mailbox"}Если это был последний включённый адрес пересылки, адрес снова сохраняет свою почту здесь.
Токену доступа OAuth для этого вызова нужен код подтверждения. Пока приложение не подтвердило код за последние 60 минут, вызов отвечает 403 step_up_required и ничего не меняет. У API-ключа его никогда не спрашивают. Страница «Аутентификация» показывает, как запросить код и подтвердить его.
Снова попросить адрес пересылки подтвердить
Требуется domains:write. POST /domains/{id}/addresses/{addressId}/forwards/{forwardId}/resend ещё раз отправляет письмо с просьбой подтвердить.
curl -X POST "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/forwards/9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d/resend" -H "$AUTH"{ "object": "address_forward_consent", "id": "9a4c1e7b-2d3f-4b5a-8c6d-0e1f2a3b4c5d", "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18", "email": "[email protected]", "status": "sent"}status равен sent, already-confirmed, если адресу пересылки ничего не нужно, too-soon, если последнее письмо ушло только что, revoked, если адрес пересылки отказался от почты из этого рабочего пространства, или send-failed, если письмо не удалось отправить.
Токену доступа OAuth для этого вызова нужен код подтверждения. Пока приложение не подтвердило код за последние 60 минут, вызов отвечает 403 step_up_required и ничего не меняет. У API-ключа его никогда не спрашивают. Страница «Аутентификация» показывает, как запросить код и подтвердить его.
Справочник
/domains/{id}/addresses/{addressId}/forwardsПолный справочник/domains/{id}/addresses/{addressId}/forwardsПолный справочник/domains/{id}/addresses/{addressId}/forwards/{forwardId}Полный справочник/domains/{id}/addresses/{addressId}/forwards/{forwardId}Полный справочник/domains/{id}/addresses/{addressId}/forwards/{forwardId}/resendПолный справочник