Reencaminhar um endereço
Para onde vai o correio de um endereço além da sua caixa de correio. Cada destino confirma por email antes de receber alguma coisa.
Executa qualquer uma das 5 chamadas no seu espaço de trabalho.
GET /domains/{id}/addresses/{addressId}/forwards
Para onde vai o correio de um endereço além da sua caixa de correio. Cada destino confirma por email antes de receber alguma coisa.
Listar os destinos
Requer domains:read. Todos os destinos do endereço, dos mais antigos para os mais recentes. destination diz se o endereço também guarda uma cópia aqui (mailbox) ou só reencaminha (forward), e max é quantos destinos um endereço pode ter.
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 quando o destino confirmou que quer o correio, pending enquanto não respondeu, refused quando disse que não e paused enquanto está desligado. Só um destino live recebe alguma coisa.
Adicionar destinos
Requer domains:write. POST /domains/{id}/addresses/{addressId}/forwards com { emails }, de 1 a 10 endereços. A cada destino novo é enviado um email a pedir-lhe que confirme, por isso começa em 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." } ]}Um endereço alojado aqui, um que já está na lista, um que criaria um ciclo, um que ultrapassa o limite de 10 e um que recusou correio deste espaço de trabalho são indicados em skipped com o motivo, e os restantes são adicionados na mesma.
Um endereço desligado é recusado com 409 address_disabled.
Uma chave limitada a determinados endereços ou domínios tem de deter o domínio inteiro, e uma app que age por um membro só pode reencaminhar um endereço que esse membro alcance.
Um token de acesso OAuth precisa de um código de verificação para esta chamada. Até a aplicação ter verificado um nos últimos 60 minutos, a chamada responde 403 step_up_required e não altera nada. A uma chave de API nunca é pedido. A página Autenticação mostra como pedir um código e verificá-lo.
Pausar ou ligar um destino
Requer domains:write. PATCH /domains/{id}/addresses/{addressId}/forwards/{forwardId} com { enabled }. Um destino em pausa mantém a sua confirmação, por isso voltar a ligá-lo não precisa de nenhuma.
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"}Quando o último destino ligado é pausado, o endereço volta a guardar o seu correio aqui, e destination indica-o.
Um token de acesso OAuth precisa de um código de verificação para esta chamada. Até a aplicação ter verificado um nos últimos 60 minutos, a chamada responde 403 step_up_required e não altera nada. A uma chave de API nunca é pedido. A página Autenticação mostra como pedir um código e verificá-lo.
Remover um destino
Requer domains:write. DELETE /domains/{id}/addresses/{addressId}/forwards/{forwardId}. Nada mais lhe é reencaminhado.
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"}Se era o último destino ligado, o endereço volta a guardar o seu correio aqui.
Um token de acesso OAuth precisa de um código de verificação para esta chamada. Até a aplicação ter verificado um nos últimos 60 minutos, a chamada responde 403 step_up_required e não altera nada. A uma chave de API nunca é pedido. A página Autenticação mostra como pedir um código e verificá-lo.
Pedir de novo a um destino que confirme
Requer domains:write. POST /domains/{id}/addresses/{addressId}/forwards/{forwardId}/resend envia mais uma vez o email de confirmação.
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 quando o destino não precisa de nada, too-soon quando o último email saiu há instantes, revoked quando o destino recusou correio deste espaço de trabalho, ou send-failed quando não foi possível enviar o email.
Um token de acesso OAuth precisa de um código de verificação para esta chamada. Até a aplicação ter verificado um nos últimos 60 minutos, a chamada responde 403 step_up_required e não altera nada. A uma chave de API nunca é pedido. A página Autenticação mostra como pedir um código e verificá-lo.
Referência
/domains/{id}/addresses/{addressId}/forwardsReferência completa/domains/{id}/addresses/{addressId}/forwardsReferência completa/domains/{id}/addresses/{addressId}/forwards/{forwardId}Referência completa/domains/{id}/addresses/{addressId}/forwards/{forwardId}Referência completa/domains/{id}/addresses/{addressId}/forwards/{forwardId}/resendReferência completa