Skip to main content
POST
email.inbox.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
username
string

The part before the @. Leave out to get a random one. The domain is provided by the service.

Required string length: 1 - 64
displayName
string

Display name shown to recipients.

Required string length: 1 - 128

Response

The result

address
string
required

The inbox's email address. It is public: pass it wherever a capability asks for an inbox.

displayName
string

Display name shown to recipients.

status
enum<string>

Whether the inbox currently sends and receives mail.

Available options:
active,
paused
createdAt
string

When the inbox was created, ISO 8601.

ref
string

Reference to what this call created. Pass it as ref to email.inbox.get or email.inbox.delete.