Create an email address
Provision a vanity address such as [email protected].
Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The local-part to provision, e.g. vita for [email protected].
1 - 64The domain to use. Defaults to the Yorlet-managed domain. Must be a verified custom domain when set.
The display name used in the From header.
120Set this address as the agent’s sending identity. Defaults to true when it is the account’s first address.
Which party to match first when an inbound sender could be a customer or an owner. Defaults to customer.
customer, owner Response
Returns the email address object.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
email_address The full email address, lowercase.
Whether this is the address the agent sends from. At most one address per account may be flagged.
The display name used in the From header.
The domain portion of the address.
The local-part portion of the address.
Which party to match first when an inbound sender could be a customer or an owner. Defaults to customer.
customer, owner The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.