Scaledmail
  1. Pre Warm Inboxes
Scaledmail
  • Scaledmail API Documentaion
  • Organization
    • Get Organizations
      GET
  • Pre Warm Inboxes
    • Pre Warm Inboxes
      GET
    • Buy Pre Warm Inboxes
      POST
  • Domain
    • Get Domains
      GET
    • Get Purchased Domains
      GET
    • Search Domains
      POST
    • Buy Domains
      POST
    • Update Domain Name
      POST
    • Update Domain Redirect
      POST
  • Package
    • Get Packages
      GET
  • Order
    • Get Order Details
      GET
    • Create Order
      POST
    • Get Orders
      GET
    • Cancel Order
      DELETE
  • Mailboxes
    • Get Mailboxes by Domain ID
      GET
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
  1. Pre Warm Inboxes

Buy Pre Warm Inboxes

POST
https://server.scaledmail.com/api/v1/buy-pre-warm-inboxes

⚠️ Requires a connected payment method#

A subscription and pre‑warm inboxes will be created automatically if available, once the request is successful.
If pre‑warm inboxes are available, the system will automatically purchase and assign them to the provided domains.

📥 Request Body Parameters#

All parameters below must be sent in the JSON body.

tag (optional)#

A custom tag to associate with this purchase.
Example: "dnsimple_test"
Can be used for internal tracking

domains (required)#

An array of domain objects to be used for pre‑warm inbox creation.
→ If any domain is invalid or unavailable, the request will fail.
Each domain object supports:

id (required)#

The internal domain record ID.
Example:
"id": "recscFIvHSqKwxfyp"

domain (required)#

The domain name.
Example:
"domain": "example.com"

redirect (optional)#

A redirect URL for the domain.
Example:
"redirect": "https://example.com"

sequencer (optional)#

Used to automatically connect the purchased pre‑warm inboxes to an email sequencer.
If provided, the system will configure the sequencer after inbox creation.
Example structure:
"sequencer": {
  "provider": "Instantly",
  "username": "ross@instantly.ai",
  "password": "InstantlyRoss456!",
  "link": "https://app.instantly.ai",
  "workspace": "paleontology-outreach",
  "tag": "{{ID}}"
}

Sequencer Fields#

FieldRequiredDescription
provider✅Sequencer provider (e.g. Instantly)
username✅Sequencer account username
password✅Sequencer account password
link✅Sequencer dashboard URL
workspace❌Workspace or account name
tag❌Tag to apply inside the sequencer

🔖 Sequencer Tag Behavior#

If the sequencer tag is set to:
"tag": "{{ID}}"
→ The system will automatically replace {{ID}} with the payment ID generated during checkout.
→ That payment ID will be used as the tag inside the sequencer.

🧠 Behavior Summary#

tag → optional, used for tracking
domains → required
redirect → optional per domain
sequencer → optional
If pre‑warm inboxes are available → they will be automatically purchased and assigned
If sequencer.tag = "{{ID}}" → payment ID will be injected automatically

Request

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

Body Params text/plain
Examples

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://server.scaledmail.com/api/v1/buy-pre-warm-inboxes?organization_id' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: text/plain' \
--data-raw '{
  "tag": "client1",
  "domains": [
    {
      "id": "recscFIvHSqKwxfyp",
      "domain": "1apitestoutlook.com",
      "redirect": "bello.com"
    },
    {
      "id": "recLuIthqG59R4nmZ",
      "domain": "1apitestgoogle.com"
    }
  ]
  "sequencer": {
    "provider": "Instantly",
    "username": "ross@instantly.ai",
    "password": "InstantlyRoss456!",
    "link": "https://app.instantly.ai",
    "workspace": "paleontology-outreach",
    "tag": "{{ID}}"
  }
}'
Response Response Example
{}
Modified at 2026-01-12 12:53:57
Previous
Pre Warm Inboxes
Next
Get Domains
Built with