Use Case 1: Mailboxes & Domains
Prerequisites
Flow Overview
Check availability → Purchase domains → Configure DNS → Create mailboxes
→ Enable warmup → (optional) Connect sequencer → Export mailboxesStep 1: Check Domain Availability
POST /check_domains{
"domains": [
"cooloutreach.com",
"growthmail.io",
"reachfast.co"
]
}{
"domains": [
{"domain": "cooloutreach.com", "available": true, "price": 1099},
{"domain": "growthmail.io", "available": false},
{"domain": "reachfast.co", "available": true, "price": 899}
]
}Step 2: Purchase Domains
POST /domains/purchase{
"workspace_id": 42,
"domains": ["cooloutreach.com", "reachfast.co"],
"contact_info": {
"first_name": "John",
"last_name": "Smith",
"real_address": "123 Main St",
"city": "San Francisco",
"state_province": "CA",
"postal_code": "94105",
"country": "US",
"phone": "+14155551234",
"email_address": "john@company.com",
"organization_name": "Acme Inc"
}
}{
"status": "success",
"message": "2 domains purchased",
"domains_purchased": ["cooloutreach.com", "reachfast.co"],
"total_charged_cents": 1998,
"invoice_id": "inv_abc123"
}Step 3: List Your Domains
GET /domains?workspace_id=42[
{
"id": 101,
"domain": "cooloutreach.com",
"status": "active",
"workspace_id": 42,
"redirect_domain": null
},
{
"id": 102,
"domain": "reachfast.co",
"status": "active",
"workspace_id": 42,
"redirect_domain": null
}
]Step 4: Configure DNS
View DNS Records
GET /domains/cooloutreach.com/dns[
{"host": "@", "type": "MX", "address": "mail.cooloutreach.com", "ttl": 1800},
{"host": "@", "type": "TXT", "address": "v=spf1 include:_spf.google.com ~all", "ttl": 1800},
{"host": "default._domainkey", "type": "TXT", "address": "v=DKIM1; k=rsa; p=MIG...", "ttl": 1800},
{"host": "_dmarc", "type": "TXT", "address": "v=DMARC1; p=none; rua=mailto:dmarc@cooloutreach.com", "ttl": 1800}
]Update DNS Records
POST /domains/cooloutreach.com/dns[
{"host": "@", "type": "A", "address": "1.2.3.4", "ttl": 1800},
{"host": "@", "type": "TXT", "address": "v=spf1 include:_spf.example.com ~all", "ttl": 1800}
]Setup Domain Redirects
PATCH /domains/redirects{
"workspaceId": 42,
"domains": ["cooloutreach.com", "reachfast.co"],
"redirectDomain": "yourcompany.com"
}Step 5: Create Mailboxes
POST /mailboxes?workspace_id=42[
{
"first_name": "John",
"last_name": "Smith",
"address": "john@cooloutreach.com",
"domain_id": 101,
"password": "SecureP@ss123"
},
{
"first_name": "Jane",
"last_name": "Doe",
"address": "jane@cooloutreach.com",
"domain_id": 101,
"password": "SecureP@ss456"
}
]{
"status": "success",
"message": "2 mailboxes created",
"setupTriggered": true
}setupTriggered: true means DNS and mail server configuration started automatically in the background.Step 6: List Mailboxes
GET /mailboxes?workspace_id=42[
{
"id": 501,
"first_name": "John",
"last_name": "Smith",
"address": "john@cooloutreach.com",
"domain_id": 101,
"status": "active",
"warmup_enabled": false,
"warmup_started_at": null
},
{
"id": 502,
"first_name": "Jane",
"last_name": "Doe",
"address": "jane@cooloutreach.com",
"domain_id": 101,
"status": "active",
"warmup_enabled": false,
"warmup_started_at": null
}
]Step 7: Enable Warmup
Start Warmup
POST /warmup/operations?workspaceId=42{
"action": "enable",
"mailboxes": ["john@cooloutreach.com", "jane@cooloutreach.com"],
"idempotencyKey": "warmup-enable-batch-001"
}{
"operationId": "op_abc123",
"status": "processing",
"action": "enable",
"workspaceId": 42,
"requestedCount": 2,
"acceptedCount": 2,
"rejectedCount": 0,
"successCount": 0,
"failureCount": 0,
"rejections": [],
"items": [
{
"mailboxId": 501,
"mailbox": "john@cooloutreach.com",
"status": "processing",
"provider": "plusvibe"
},
{
"mailboxId": 502,
"mailbox": "jane@cooloutreach.com",
"status": "processing",
"provider": "plusvibe"
}
]
}Check Warmup Operation Status
GET /warmup/operations/op_abc123?workspaceId=42requested → processing → completed | partial | failedView Warmup State
GET /warmup/mailboxes?workspaceId=42[
{
"mailboxId": 501,
"mailbox": "john@cooloutreach.com",
"warmupEnabled": true,
"warmupStartedAt": "2026-03-09T10:00:00Z",
"providerAccountId": "pv_abc123"
}
]Disable Warmup
POST /warmup/operations?workspaceId=42{
"action": "disable",
"mailboxes": ["john@cooloutreach.com"],
"idempotencyKey": "warmup-disable-001"
}Step 8: Update Mailboxes
POST /update_mailboxes{
"mailboxes": ["john@cooloutreach.com"],
"firstName": "Jonathan",
"lastName": "Smith",
"signature": "<p>Best regards,<br/>Jonathan Smith</p>",
"forwardTo": "main@company.com"
}Step 9: Connect a Sequencer (Optional)
List Available Providers
GET /sequencers/providers?workspaceId=42Validate Credentials
POST /sequencers/validate{
"provider": "instantly",
"apiKey": "inst_your_api_key"
}Create Connection
POST /sequencers?workspaceId=42{
"provider": "instantly",
"name": "My Instantly Account",
"apiKey": "inst_your_api_key",
"autoExportMailboxes": true,
"autoReconnectMailboxes": true
}Export Mailboxes to Sequencer
POST /sequencers/{connection_id}/export{
"mailboxAddresses": [
"john@cooloutreach.com",
"jane@cooloutreach.com"
]
}{
"provider": "instantly",
"connectionId": "seq_abc123",
"exported": 2,
"failed": 0,
"details": [
{"email": "john@cooloutreach.com", "providerAccountId": "inst_001"},
{"email": "jane@cooloutreach.com", "providerAccountId": "inst_002"}
]
}Reconnect Disconnected Mailboxes
POST /sequencers/{connection_id}/reconnectStep 10: Upgrade Subscription
POST /workspaces/42/upgrade_subscription?newMaxMailboxes=200GET /workspaces/42/creditsStep 11: Delete Mailboxes
DELETE /mailboxes?addresses=john@cooloutreach.com&addresses=jane@cooloutreach.comComplete Python Example
Related
Modified at 2026-03-10 01:37:58