Skip to navigation
API ReferenceForwarding

Update Forwarding

Set the addresses the organization forwards to. The list replaces the current one. An address that is not verified is saved but receives nothing until it is verified. Needs an organization-scoped API key in an organization that has completed agent verification.

CLI:

agentmail forwarding update --destinations ops@example.com --destinations archive@example.com

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
destinationslist of stringsRequired
The full list of addresses this level forwards to. It replaces the level's current list. At most 5, with no repeats. Send an empty list to turn forwarding off at this level, even when a level above forwards.

Response

This endpoint returns an object.
destinationslist of strings

The list now set on this level. It does not say which addresses are verified; Get Forwarding does.

Errors

400
Validation Error
403
Forwarding Forbidden Error