Skip to navigation
API ReferenceForwarding

Delete Forwarding

Remove the organization’s forwarding, so its inboxes stop forwarding unless their pod or the inbox sets its own. Verified addresses stay verified, so adding one again needs no new code. Returns not_found when the organization sets no forwarding.

CLI:

agentmail forwarding delete

Authentication

AuthorizationBearer

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

Response

This endpoint returns an object.
destinationslist of strings or null

Addresses this level forwards to. null when the level sets nothing and uses the forwarding of the level above. An empty list means forwarding is turned off at this level, even when a level above forwards.

unverifiedlist of strings

Addresses in destinations that receive nothing yet because they are not verified, or because the address now reaches a different AgentMail inbox than the one it was verified for. Verify them with Start Verification and Confirm Verification. Empty when destinations is null.

Errors

403
Forwarding Forbidden Error
404
Not Found Error