API ReferenceInboxes

Create Inbox

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
usernamestringOptional

Username of address. Randomly generated if not specified.

domainstringOptional

Domain of address. Must be verified domain. Defaults to agentmail.to.

display_namestringOptional

Display name: Display Name <username@domain.com>. Defaults to AgentMail. Pass empty string to omit.

Response

This endpoint returns an object.
inbox_idstring

ID of inbox.

display_namestring

Display name: Display Name <username@domain.com>.

created_atdatetime

Time at which inbox was created.

Errors