Skip to content

PUT · Bearer

PUT /api/v1/inboxes/:id/forwarding

Summary

Replace the verified auto-forward list. Body is {emails}. Each address must already be verified on this inbox (400 forwarding_not_verified). Pending rows stay. An empty array removes every verified destination. More than 5 destinations, counting pending rows, is 409 forwarding_limit. Write permission is inbox_update. The confirmation code is not accepted.

Request

{
  "emails": [
    "archive@example.com"
  ]
}

Response

The OpenAPI document does not declare a JSON response schema for this call. The summary is the contract.

Errors

  • HTTP 400 forwarding_not_verified
  • HTTP 409 forwarding_limit

Idempotency

This route does not document Idempotency-Key or client_id.