Forwarding API
Forward the email your inboxes receive to confirmed addresses or a webhook, with rules, a pattern tester and a forward log.
- GETList forwarding rules
/v1/forwarding-rulesEvery forwarding rule of the team, in the order they are tried, with its addresses and whether each is confirmed.
- POSTCreate a forwarding rule
/v1/forwarding-rulesForward email received at matching addresses to confirmed forwarding addresses, a webhook, or both.
- POSTTest an address against your rules
/v1/forwarding-rules/testShows which rule takes a message sent to an address, whether it is forwarded (forwards; a paused rule takes the message and forwards nothing), and every…
- GETGet a forwarding rule
/v1/forwarding-rules/{id}One rule, with paused and pauseReason: BREAKER (too many forwards in 10 minutes), REPUTATION (bounces or complaints on the team's forwards), KEY_REVOKED…
- PATCHChange a forwarding rule
/v1/forwarding-rules/{id}Change any field of a rule.
- DELDelete a forwarding rule
/v1/forwarding-rules/{id}Delete a rule.
- GETRead a rule's forward log
/v1/forwarding-rules/{id}/logOne row per message and address: SENT with the emailId of the forward (read it with GET /v1/emails/{id}), SKIPPED or FAILED with the reason.
- GETList forwarding addresses
/v1/forwarding-destinationsEvery forwarding address of the team, newest first, with status PENDING or VERIFIED.
- POSTAdd a forwarding address
/v1/forwarding-destinationsAdd an address to forward to.
- DELRemove a forwarding address
/v1/forwarding-destinations/{id}Remove an address.