DomainController

Create Domain

Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.

post/domains

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/domains
  • Auth: API key in header x-api-key

Request body

domainstring required

The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So test.com covers all subdomains such as mail.test.com. Don't include a protocol such as http://. Once added you must complete the verification steps by adding the returned records to your domain.

descriptionstring nullable

Optional description of the domain.

createdCatchAllInboxboolean nullable

Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID.

domainType'HTTP_INBOX' | 'SMTP_DOMAIN' nullable

Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.

Response

Created

Changes

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