Skip to navigation
API ReferenceInboxesForwarding

Update Forwarding

Set the addresses this inbox forwards to. The list replaces the inbox’s current one and any pod or organization list for this inbox; lists are never combined. Send an empty list to stop this inbox forwarding even when its pod or the organization forwards. An address that is not verified is saved but receives nothing until it is verified.

CLI:

agentmail inboxes forwarding update --inbox-id <inbox_id> --destinations ops@example.com

Authentication

AuthorizationBearer

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

Path parameters

inbox_idstringRequired
The ID of the inbox.

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
404
Not Found Error