1. Domain
Scaledmail
  • Scaledmail API Documentaion
  • Workspaces
    • Get Workspaces
      GET
    • Create Workspace
      POST
  • Pre Warm Inboxes
    • Pre Warm Inboxes
      GET
    • Buy Pre Warm Inboxes
      POST
  • Domain
    • Get Domains
      GET
    • Get Domain Masking
      GET
    • Get Purchased Domains
      GET
    • Buy Domains
      POST
    • Search Domains
      POST
    • Suggest Domains
      POST
    • Update Sender Name
      POST
    • Update Domain Name
      POST
    • Update Domain Redirect
      POST
    • Update Domain Masking
      POST
  • Package
    • Calculate Package
      POST
    • Get Packages
      GET
  • Order
    • Get Orders
      GET
    • Get Order Details
      GET
    • Cancel Order
      DELETE
    • Create Order
      POST
    • Create Custom Order
      POST
    • Update Order Tag
      PATCH
  • Mailboxes
    • Get Mailboxes by Domain ID
      GET
  • Stats
    • Get Reporting Stats
  1. Domain

Update Domain Redirect

POST
https://server.scaledmail.com/api/v1/swap-redirect/{domain}
↪️ Use this endpoint to update (or remove) the redirect URL for an existing domain.
⚠️ This creates a pending request, same as /swap-domain and /swap-sender-name — it does not take effect immediately. Our team reviews and applies it.

🔑 Authentication#

Requires a valid API token.
POST /api/v1/swap-redirect/:old_domain

🔑 Path Parameters#

old_domain (required)#

The domain whose redirect URL you want to update. Must already exist in your account.

🔑 Query Parameters#

organization_id (required)#

Your organization's ID. The domain must belong to this organization.

📥 Request Body Parameters#

new_redirect (required)#

The new redirect URL, or an explicit "remove" signal.
{ "new_redirect": "https://mybrand.com/landing" }
The new_redirect key must be present in the body — omitting it entirely returns an error.
https:// is added automatically if you omit the protocol (e.g. "mybrand.com" becomes "https://mybrand.com").
Pass an empty string ("") or null to remove the domain's existing redirect.
Cannot be the same as the domain's current redirect.

📋 Example Requests#


Example 1 — Set a new redirect#

POST /api/v1/swap-redirect/outreach-one.com?organization_id=recXXXXXXXXXXXXXX
{
  "new_redirect": "mybrand.com/landing"
}

Example 2 — Remove an existing redirect#

POST /api/v1/swap-redirect/outreach-one.com?organization_id=recXXXXXXXXXXXXXX
{
  "new_redirect": ""
}

✅ Response#

{
  "message": "Redirect Swap Requested"
}

⚠️ Error Responses#

Missing new_redirect#

{ "error": "new_redirect is required" }

Invalid domain format#

{ "error": "Invalid domain format" }

Invalid redirect format#

{ "error": "Invalid redirect format" }

Domain not found#

{ "error": "Domain not found" }

Domain uses Domain Masking#

{ "error": "Domain outreach-one.com is using Domain Masking, not a plain redirect -- use POST /swap-domain-masking/outreach-one.com instead" }

Same redirect#

{ "error": "Cannot use same redirect" }

Conflicting pending request already exists#

{ "error": "Cannot create domain swap request. Domain \"outreach-one.com\" already has a pending Redirect URL change request (Status: New Order)" }

ℹ️ Notes#

Rejected if the domain uses Domain Masking — use Swap Domain Masking instead.
This endpoint cannot be used by test accounts.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Query Params

Body Params text/plain
Examples

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://server.scaledmail.com/api/v1/swap-redirect/?organization_id=undefined' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: text/plain' \
--data '{
 "new_redirect":"scaledmail.com"
}'
Response Response Example
{}
Modified at 2026-09-21 11:16:57
Previous
Update Domain Name
Next
Update Domain Masking
Built with