Skip to content
Extrovert Extrovert Docs

Create an inbox from the console

POST
/v1/admin/orgs/{org_id}/projects/{project_id}/inboxes

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
org_id
required
string
project_id
required
string

Request Body required

Section titled “Request Body required ”
object
username

Local part. On extrovertmail.com and free.extrovertmail.com it is normalized to lowercase, must contain at least five characters, and must not be postmaster, admin, webadmin, legal, fraudmark, fraudmarc, keith, melissa, richard, sydney, syd, john, or johnny. These restrictions do not apply to customer-owned domains. Omit it for a generated local part.

string
domain_id

Domain id from the console domains list.

string
domain

Domain name fallback when domain_id is omitted.

string
agent_id
required

Active agent that owns the new inbox.

string
display_name
string
webhook_url
string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created.

object
address
string
agent_id
string
domain
string
webhook_url
string
daily_send_used

Recipients sent in the rolling 24-hour window.

integer
daily_send_cap
integer
direct_smtp_enabled

Whether this inbox is configured for direct SMTP outside the review pipeline. Effective access also requires an active paid entitlement.

boolean
created_at
string format: date-time

400

Section titled “400 ”

Invalid request.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope

401

Section titled “401 ”

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope

403

Section titled “403 ”

Authenticated but lacking the required scope, or out of quota.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope

404

Section titled “404 ”

Resource not found.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope