Sign in

v1

latestOpenAPI 3.0.02026-07-13474670.4 KB
Addresses

Reserve (create/own) a private email address

Sets the email address private and "owned" by the account. All messages which already exist, and any future messages which are received, will be private to this account only.

An email address must be reserved to be able to forward messages to another email address, Slack, web sockets, or webhooks. Public email addresses, and private email addresses under a custom domain, are not routeable.

post/addresses/{email}

Request body

infostring

User configurable metadata about this enhanced private address.

forwardstring

email address - SMTP forwarding / standard email forwarding - set to "" or null to disable forwarding

enablewsboolean

boolean, defaults false - set to true to enable web socket forwarding (see Web Socket API)

webhookstring

url - set to your public webhook endpoint to receive mail via webhook - set to "" or null to disable webhooks

webhookSlackstring

Slack webhook URL where messages will be published.

webhookSlackToFromboolean

When webhookSlack is set, controls whether the message includes TO and FROM

Response

Returns the newly created email address

_idstring email

the unique identifier of this email address is the email address itself

infostring

Allows setting custom information about this email address.

enabledwsboolean

boolean defaulting false indicating whether to publish messages via web socket when the user owning this inbox is subscribed

forwardstring email

email address where messages to this inbox will be forwarded

webhookstring url

URL where messages to this inbox will be forwarded

webhookSlackstring url

Slack webhook endpoint where messages should be published

webhookSlackToFromboolean

When webhookSlack is set, controls whether the message includes TO and FROM

ownerstring

Account that owns the address (owns the privacy)

encryptedInboxstring email

An alternate email address that will result in the message being delivered to this inbox. This is not always present.

catchAllstring domain

Indicates whether this is a catch-all address, and for which domain.

implicitboolean

When the user owns the domain but has not reserved the address individually, this field is set to true.

createdstring date-time
updatedstring date-time

Example response

{
  "encryptedInbox": "inbox-cf5abefaf492601c5fe0a1563c00b76816145206@mailsac.com"
}