Resend API (unofficial showcase)
POST/inboxes

Create an inbox

Creates an inbox that sends and receives email at an address on one of the team's domains. Supply email_address and choose whether to enable forwarding; the domain's verification requirements depend on that setting.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

Inbox configuration, including the required email address and optional display names and forwarding setting.

email_addressstringrequired
The inbox email address on one of your domains. The API trims and lowercases it. The part before the `@` is at most 64 characters and contains only letters, numbers, and `. _ % + -`. It cannot start or end with a dot or contain two dots in a row.
namestringoptional
Internal name for the inbox. Recipients do not see it. Max 64 characters. Defaults to `email_address`.
from_namestringoptional
The name recipients see when mail is sent from this inbox. A plain name, not a `Name <email>` address. Max 78 characters. It cannot contain a colon, `<`, `>`, line breaks, or other control characters. An email address inside the name must be on a domain the team has verified for sending. An empty string leaves it unset.
forwardingbooleanoptional
When `true`, Resend provisions a receiving address so you can receive mail without adding an MX record. The address is returned in `receiving_address`.
Default:false

1 status code
201Returns the created inbox's ID.
objectstringrequired
Type of the response object.
idstringrequired
The ID of the inbox.

Error handling

Provide email_address with a local part of at most 64 characters using only letters, numbers, ., _, %, +, or -; it cannot start or end with a dot or contain consecutive dots. The domain must belong to the team: without forwarding, it needs receiving enabled, verified DKIM and SPF, and an inbound MX record that is verified or pending. With forwarding set to true, the domain needs verified DKIM and SPF, and the team must have an inbound domain.