Inboxes

Create an inbox

Organise one address on your own domain as an inbox with threads, labels, folders and drafts. The domain must have receiving turned on and be able to send (mail from the inbox is sent from its address): verified for sending, or a receiving subdomain of a verified domain. SMTPfast never provisions addresses on a shared domain, so forwarding: true is refused and receiving_address is always null. Mail the address already received in the last 30 days is filed into threads. Requires the domain:write scope on a key created by a team owner or admin.

post/v1/inboxes

Request

Base URL: https://smtpfa.st/api
URL: https://smtpfa.st/api/v1/inboxes
Auth: HTTP bearer

Request body

email_addressstring email required

A plain address on one of your domains, such as support@example.com

namestring

Internal name. Defaults to email_address.

from_namestring

The name recipients see. A plain name, not a Name <email> address.

forwardingboolean

Not available: must be false or omitted. Inboxes receive through your domain's MX record.

Response

The new inbox

objectstring

idstring

namestring

email_addressstring

domain_idstring

receiving_addressunknown

from_namestring nullable

unreadinteger

Threads in the inbox folder with at least one unread message

draftsinteger

Unsent drafts

last_receivedstring date-time nullable

When a thread in this inbox was last active

created_atstring date-time

Example response

{
  "object": "inbox",
  "name": "Customer Support",
  "email_address": "support@example.com",
  "from_name": "Ada from Support"
}

Changes

No recorded changes to this operation across all 1 revision of this API.