1. Warmup
InboxKit
  • Introduction
  • Quick Start
  • Domain Management
  • Mailbox Operations
  • Deliverability Monitoring
  • Order
    • Place Order
      POST
  • Webhook
    • Events: OAuth Consent & Client ID Changes
      POST
    • Event: Mailbox Status Changed
      POST
    • Webhook Integration & Signature Verification
      POST
    • Event: Domain Status Changed
      POST
  • Account
    • Get account details
      GET
  • Workspaces
    • List workspaces
      GET
    • Create workspace
      POST
    • Invite Member to Workspace
      POST
    • Get workspace details
      GET
    • Update workspace
      PUT
    • Delete workspace
      DELETE
    • Update workspace webhook
      POST
  • Domains
    • Domain Renewals
    • Check if domain is banned from registration
    • Check domain availability
    • Register domains
    • List domains
    • List assignable domains
    • Remove domains
    • Set domain forwarding
    • Set catch-all email
    • Remove catch-all email
    • Get nameservers for domain connection
    • Check nameservers propagation
    • Check Workspace Availability
    • Set DMARC Configuration
    • Remove DMARC Configuration
    • Regenerate Domain Nameservers
    • Request Domain Renewal
    • Check Renewal Status
    • Update Domain Privacy
    • Update Domain Contact Details
    • Search available domains
    • Move domains to another workspace
    • Preview a domain move
    • Get domain move status
    • Start a domain rotation
    • Preview a domain rotation
    • Get domain rotation status
  • Cloudflare Domains
    • Connect Cloudflare Domains
    • List Connected Cloudflare Domains
    • Get Domain Details
    • Disconnect Cloudflare Domains
    • List Cloudflare Zones
  • Mailboxes
    • Microsoft 365 & Azure Reactivation
      • Reactivate mailboxes (Microsoft 365 / Azure)
      • Re-purchase mailboxes for reactivation (Microsoft 365 / Azure)
    • List mailboxes
    • Add or update signature for mailboxes
    • Delete signature for mailboxes
    • Show mailbox credentials
    • Get mailbox details
    • Buy mailboxes
    • Check mailbox status
    • Cancel mailboxes
    • Update mailbox
    • Update mailbox profile picture
    • Generate TOTP
    • Change username
    • Change password
    • Check mailbox availability
    • Get Failure Reason
    • Uncancel mailboxes
    • Resetup mailboxes
    • Get resetup status
  • DNS
    • Get DNS records
    • Add DNS records
    • Update DNS records
    • Delete DNS records
    • Verify DNS records
    • Repair DNS records
  • Sequencers
    • Export mailboxes status
    • List sequencer platforms
    • Get sequencer tags
    • List sequencers
    • Export mailboxes
    • Add sequencer
    • Update sequencer
    • Delete sequencers
    • Verify Lemlist OTP
  • Billing
    • Get pricing plans
    • Add Credits to Wallet
    • Get subscription details
    • Check Payment Status
    • Change subscription plan
    • Cancel subscription
    • Get wallet details
    • Update auto top-up settings
    • Get billing portal link
    • Get Wallet Logs
    • List Wallet Transactions
  • Warmup
    • Your Own Mailboxes
      • Create a Connect Link
      • Get Connect Link Status
      • Add SMTP Mailboxes
      • List Your Connected Mailboxes
      • Disconnect a Mailbox
    • List Warmup Subscriptions
      POST
    • Get Warmup Subscription Details
      GET
    • Add Warmup to Mailboxes
      POST
    • Pause Warmup for Mailboxes
      POST
    • Resume Warmup for Mailboxes
      POST
    • Cancel Warmup for Mailboxes
      POST
    • Get Warmup Statistics
      GET
    • Get Warmup Pricing
      GET
    • Update Warmup Settings
      POST
  • Client ID Requests
    • Initiate Client ID Request
    • Get Client ID Request Status
    • List Client ID Requests
  • Consent Request
    • Initiate Consent Request
    • Get Consent Request Status
    • List Consent Requests
  • Tags
    • Assign tags to domains or mailboxes
    • Get all tags
    • Create a new tag
    • Delete a tag
  • Prewarm
    • Search Domains
    • Search Mailboxes
    • Buy Prewarmed Mailboxes
    • Check Order Status
    • Check Availability
  • Inbox Placement
    • Tests
      • Create Test
      • List Tests
      • Get Test Results
    • Scheduled Tests
      • List Scheduled Tests
      • Get Scheduled Test
      • Pause Scheduled Test
      • Resume Scheduled Test
      • Delete Scheduled Test
  • InfraGuard
    • InfraGuard - Subscriptions
      • List protected domains
      • Get subscription details
      • Enable InfraGuard for domains
      • Cancel InfraGuard for domains
      • Get workspace statistics
      • Get pricing info
    • InfraGuard - Monitoring
      • Get blacklist check history
      • Get DNS check history
      • Get current bounce metrics
      • Get bounce check history
    • InfraGuard - Settings
      • Update subscription settings
      • Trigger manual check
    • InfraGuard - Alerts
      • List alerts
      • Acknowledge an alert
      • Resolve an alert
    • InfraGuard - Action Items
      • List action items
      • Get action item statistics
      • Resolve an action item
      • Dismiss an action item
  • Email Insight
    • Email Insights - Workspace
      • Get Workspace Overview
      • Get Mailboxes Health
      • Get High Bounce Mailboxes
      • Get Workspace Daily Stats
      • Get Workspace Campaign Reply Rate
      • Get Workspace Activity
    • Email Insights - Mailbox
      • Get Mailbox Stats
      • Get Mailbox Deliverability
      • Get Mailbox Warmup Stats
      • Get Mailbox Health
      • Get Mailbox Trends
      • Get Mailbox Bounce Events
      • Get Mailbox Activity
      • Get Mailbox Top Recipients
      • Get Mailbox Top Recipient Domains
      • Get Mailbox Message Breakdown
      • Get Mailbox Subject Analysis
      • Get Mailbox Reply Time Heatmap
      • Get Mailbox Reply Rate By Domain
      • Get Mailbox Velocity Overlay
      • Get Mailbox Auth Failures
      • Get Mailbox First Touch Funnel
      • Get Mailbox Sending IP Breakdown
      • Get Mailbox Recipient ESP Breakdown
      • Get Mailbox Body Templates
  • Domain Renewals
  • Verified Domains
    • List verified destinations
    • Add a destination to verify
    • Verify a destination
    • Remove a destination
  • MCP
    • InboxKit for Claude
    • Connect InboxKit to Claude
    • What Claude can do
    • Confirming changes
    • Privacy
    • Common questions
  • Mailbox Forwarding
    • Normal Forwarding
      • Setup Email Forwarding
      • Update Email Forwarding
      • Remove Email Forwarding
      • List Forwarding Jobs
    • Advanced Forwarding
      • Get Forwarding Capabilities
      • Set Up Advanced Forwarding
      • List Forwarding Rules
      • Get Forwarding Rule
      • Update Forwarding Rule
      • Delete Forwarding Rule
  • Email Messages
    • List messages
    • List messages (POST)
    • Get a message
  • Schemas
    • Schemas
      • WebhookPayload
      • DomainStatusWebhook
      • Tag
      • DomainEventData
      • MailboxStatusWebhook
      • MailboxEventData
      • Domain
      • Mailbox
      • ChangeDetails
      • WebhookResponse
      • ErrorResponse
  1. Warmup

Get Warmup Subscription Details

GET
https://api.inboxkit.com/v1/api/warmup/details
Maintainer:Not configured
Get the warmup subscription of one mailbox, by the mailbox uid. Warmup added when buying mailboxes shows pending_activation until the mailbox is ready.
Your own mailboxes. To see the warmup of a mailbox you connected yourself, send its ext_mbx_ UID from List Your Connected Mailboxes as uid. The response has the same shape, with the fields described in List Warmup Subscriptions. If the mailbox has no warmup that is active, paused or waiting on a renewal payment, the response is 404.

Request

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

Header Params

Responses

🟢200Success Response
application/json
Bodyapplication/json

🟠404Not Found
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.inboxkit.com/v1/api/warmup/details?uid=mb-123e4567-e89b-12d3-a456-426614174000' \
--header 'X-Workspace-Id;' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "error": false,
    "message": "Warmup subscription details retrieved successfully",
    "subscription": {
        "uid": "ws-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "status": "active",
        "mailbox_email": "[email protected]",
        "price_per_month": 3,
        "health_status": "good",
        "started_at": "2025-01-15T10:30:00.000Z",
        "paused_at": null,
        "cancelled_at": null,
        "next_billing_date": "2025-02-15T10:30:00.000Z",
        "cached_stats": {
            "emails_sent": 150,
            "emails_received": 120,
            "health_score": 85.5,
            "inbox_rate": 92.3,
            "current_volume": 25,
            "target_volume": 50,
            "warmup_day": 14,
            "config": {
                "starting_volume": 12,
                "daily_increase": 3,
                "target_volume": 45,
                "reply_rates": {
                    "inbox": {
                        "min": 30,
                        "max": 45
                    },
                    "promotions": {
                        "min": 15,
                        "max": 25
                    },
                    "spam": 100
                }
            }
        },
        "mailbox": {
            "uid": "mb-123e4567-e89b-12d3-a456-426614174000",
            "username": "john",
            "domain_name": "example.com",
            "first_name": "John",
            "last_name": "Doe",
            "platform": "GOOGLE",
            "status": "active"
        },
        "createdAt": "2025-01-15T10:30:00.000Z"
    }
}
Modified at 2026-10-22 10:55:19
Previous
List Warmup Subscriptions
Next
Add Warmup to Mailboxes
Built with