Update Domain Name

🔑 Query Parameters

domain (required):
The old domain name you want to swap out.

provider (required):
Specifies the source of the new domain:
→ "scaledmail" — Domain purchased through ScaledMail
→ "other" — Domain from external providers like Porkbun, Namecheap, or DNSimple

📥 Request Body Parameters

All parameters below must be included in the JSON body of the request.

new_domain (required):
The name of the new domain you want to assign.
→ This can be either a third-party domain (external) or an available purchased domain retrieved from the /purchased-domains endpoint.

hosting (conditionally required):
Required only when provider = "other" (i.e., for third-party domains).
→ Not required if provider = "scaledmail" — ScaledMail handles hosting automatically.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location 'https://server.scaledmail.com/api/v1/swap-domain/?organization_id=undefined&provider=undefined' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "new_domain": "scaledmailgo.com" }'

🔑 Query Parameters#

📥 Request Body Parameters#

Request

Responses

🔑 Query Parameters

📥 Request Body Parameters