Forward Mail Item
POST/subscription/:external_id/mail/:item_id/forward
Requests a specific mail item to be physically forwarded to the customer's address. The item_id is obtained from webhook notifications when mail is scanned.
Important: This endpoint is disabled by default. To enable mail forwarding via the API, please contact the Hoxton Mix team to have it enabled in the ops dashboard.
Billing: When mail forwarding is enabled, the Partner will be billed for all forwarding charges, not the end customer. Charges will be invoiced to the partner after the mail item has been forwarded.
Request
Responses
- 200
- 400
- 404
Mail forwarding request accepted
Bad request - mail item may have already been forwarded
The specified mail item could not be found