Sign in

v1

latestOpenAPI 3.0.02026-07-13474670.4 KB
Addresses

Fetch an address or check if it is reserved

get/addresses/{email}

Response

Returns an object if owned by the current account, OR is not owned. Includes the encryptedInbox field. If not owned, will omit the owner key.

_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"
}