API ReferencePodsInboxes

Create Inbox

Authentication

AuthorizationBearer

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

Path Parameters

pod_idstringRequired
ID of pod.

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>.

client_idstringOptional
Client ID of inbox.

Response

This endpoint returns an object.
inbox_idstring
ID of inbox.
updated_atdatetime
Time at which inbox was last updated.
created_atdatetime
Time at which inbox was created.
display_namestring or null

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

client_idstring or null
Client ID of inbox.

Errors