Skip to main content
POST
Create an email address

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
local_part
string
required

The local-part to provision, e.g. vita for [email protected].

Required string length: 1 - 64
domain
string

The domain to use. Defaults to the Yorlet-managed domain. Must be a verified custom domain when set.

display_name
string

The display name used in the From header.

Maximum string length: 120
agent
boolean

Set this address as the agent’s sending identity. Defaults to true when it is the account’s first address.

match_priority
enum<string>

Which party to match first when an inbound sender could be a customer or an owner. Defaults to customer.

Available options:
customer,
owner

Response

200 - application/json

Returns the email address object.

id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
email_address
address
string
required

The full email address, lowercase.

agent
boolean
required

Whether this is the address the agent sends from. At most one address per account may be flagged.

display_name
string | null
required

The display name used in the From header.

domain
string
required

The domain portion of the address.

local_part
string
required

The local-part portion of the address.

match_priority
enum<string>
required

Which party to match first when an inbound sender could be a customer or an owner. Defaults to customer.

Available options:
customer,
owner
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.