Create a new email inbox. Omit `domain` for a built-in `@mail.pingram.io` address; set `domain` and `displayName` for a custom address on a verified domain.

POST

/addresses

• Production

Authorizations

• apiKey
• clientCredentials
• endUser
• endUserHashed

Request Body ^required

object

prefix

required

string

domain

string

displayName

string

Responses

200

Successful response

object

address

required

object

fullAddress

required

string

prefix

required

string

domain

required

string

type

required

string

Allowed values: builtin custom

displayName

string

createdAt

required

string

400

Bad Request - validation errors, invalid input

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

401

Unauthorized

402

Payment Required - usage limits exceeded

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

500

Internal Server Error

502

Bad Gateway - provider error

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string