forwarding

Start Verification

Changed on

Email a confirmation code to an address, so it can receive forwarded mail once confirmed. Verification belongs to the organization: once verified, the address can be used at the organization, any pod and any inbox. Starting again replaces any code already sent to the address. Needs an organization- or pod-scoped API key in an organization that has completed agent verification.

CLI:

agentmail forwarding start-verification --destination ops@example.com
post/v0/forwarding/verifications

Request

Request body

destinationstring required

Email address that receives a copy of each email. Stored trimmed and lowercased, at most 320 characters.

Response

Response with status 200

expires_atstring date-time required

Time at which the emailed code stops working, 24 hours after it was sent.

Changes