Skip to navigation

Start Verification

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

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
destinationstringRequired
Address to verify. AgentMail emails it a confirmation code.

Response

This endpoint returns an object.
expires_atdatetime
Time at which the emailed code stops working, 24 hours after it was sent.

Errors

400
Validation Error
403
Forwarding Forbidden Error
422
Unprocessable Error
429
Forwarding Rate Limit Error