Skip to main content
POST
Replace the email domain

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the app whose email domains you want to work with.

Body

application/json

Request to replace email domain with a new one.

domain
string
required

Domain to move to. It has to be connected to this app and different from the current one.

Example:

"mail.example.com"

sender_name
string
required

Name recipients see in the From line.

Example:

"Nordwind Furniture"

from_email
string<email>
required

Address mail is sent from once the new domain verifies.

Example:

"no-reply@mail.example.com"

Response

The new domain's setup started. The old one keeps sending until it verifies.

Response for replacing email domain.

domain
string
required

The domain being moved to.

Example:

"mail.example.com"

status
string
required

Where the new domain's setup got to. The old one keeps sending until this reads active.

Example:

"pending_domain_verification"

email_domain_id
string
required

ID of this app's email configuration. It identifies the configuration, not the individual domain.

Example:

"68b1c0d4e7b91d003c45a1f2"

external
boolean
default:false

true when you brought the new domain yourself, false when it was bought through Base44.

Example:

false

dns_records
EmailDnsRecordResponse · object[] | null

Records to publish for the new domain.

Example: