1. Events
  • Welcome to the Cold Mail Reseller API
  • Get Started
    • Overview
    • Authentication
    • Quick Start
  • Core Concepts
    • Users
    • Domains
    • DNS Management
    • Mailboxes
    • Subscriptions
    • Pre-Warmup
    • Domain Renewal
    • 1+ Year Subscriptions
    • Mailbox Warmup
    • Platform Exports
    • OAuth Exports
    • Sandbox API
  • API Reference
    • Users
      • List Users
      • Get User
      • Create User
      • Update User
      • Delete User
    • Geo
      • List Countries
      • List States
    • Domains
      • Domain Renewal
        • Get Domain Renewal Prices
        • Renew Domains
        • Toggle Domain Auto-Renew
      • Get Domains by User
      • Check Domain Availability
      • Check Single Domain Availability
      • Check Workspace Existence
      • Set Domain Forwarding
      • Set Email Forwarding
      • Delete Domains
    • DNS
      • Get DNS Records
      • Add DNS Records
      • Update DNS Record
      • Update Nameservers
      • Delete DNS Record
    • Mailboxes
      • List Mailboxes
      • Get Mailboxes by User
      • Get Mailbox
      • Get Admin Mailbox Details
      • Update Mailbox Details
      • Delete Mailbox
    • Mailbox Warmup
      • Add Warmup to Mailbox
      • Toggle Warmup
      • Update Warmup Settings
      • Set Warmup Status
      • Disable Warmup
    • Orders
      • Get Order Status
      • Get Order Details
      • Create Order
      • Create Order (JSON)
      • Create Mailbox Order (JSON)
      • Process Order
    • Subscriptions
      • 1+ Year Subscription
        • Recreate Subscription
      • Get Subscriptions
      • Renew Subscriptions
      • Cancel Subscription
      • Toggle Auto-Renewal
    • Exports
      • Platform Exports
        • Get Platform Credentials
        • Add Platform Credential
        • Export Mailboxes to Platform
        • Remove Platform Credential
      • OAuth Exports
        • Perform OAuth
        • Add Client ID to Domains
    • Pre-Warmup
      • Sandbox
        • Get Sandbox Pre-warmup Domains
        • Order Sandbox Pre-warmup
        • Reset Sandbox Pre-warmup
      • Get Pre-warmup Domains
      • Order Pre-warmup
    • Placement Test
      • Create Placement Order
      • Get Placement Reports
  • Resources
    • Errors
    • Rate Limits
    • Pagination
    • Sandbox
    • MCP
  • Webhooks
    • Overview
    • Events
      • Domain Events
      • Mailbox Events
      • Subscription Events
      • Prewarmup Events
      • Mailbox Warmup Events
  • Schemas
    • Error
    • Success
    • MessageResponse
    • User
    • Domain
    • ErrorResponse
    • Mailbox
    • Subscription
    • DnsRecord
    • Error Response
    • Pagination Meta
    • Action Error Response
    • PrewarmupOrderResult
    • OrderCreationResult
  1. Events

Mailbox Warmup Events

Warmup events are triggered when a mailbox's warmup state changes — either when warmup is enabled or when it is permanently removed.

Overview#

The mailbox warmup event lifecycle occurs in two scenarios:
1.
Warmup started — When warmup is enabled on a mailbox and it moves to an active warmup state
2.
Warmup removed — When warmup is permanently disabled on a mailbox

mailbox.warmup.started#

This event is fired after warmup is turned on via POST /account/warmup/enable and the mailbox transitions to ACTIVE warmup status.

When it occurs#

A partner or user enables warmup for a mailbox
The mailbox successfully moves to the ACTIVE warmup state
The warmup schedule begins sending low-volume warm-up emails

Example Payload#

{
  "eventType": "mailbox.warmup.started",
  "data": {
    "userId": "HATSA7AB56M513Q6EBF005YFHDQT",
    "userEmail": "partner-user@example.com",
    "mailboxId": "4165WDY91BMKS6JD341FKQ5XVP19",
    "email": "alice@acmecorp.com",
    "domain": "acmecorp.com",
    "workspaceType": "GOOGLE"
  }
}

Payload Schema#

FieldTypeDescription
eventTypestringAlways "mailbox.warmup.started"
data.userIdstringID of the user who owns the mailbox
data.userEmailstringEmail address of the user
data.mailboxIdstringUnique identifier for the mailbox
data.emailstringThe mailbox email address being warmed up
data.domainstringDomain of the mailbox
data.workspaceTypestringWorkspace provider (e.g., "GOOGLE", "MICROSOFT")

mailbox.warmup.removed#

This event is fired when warmup is permanently disabled via DELETE /mailboxes/warmup?mailboxId=.

When it occurs#

A partner or user permanently disables warmup for a mailbox
The warmup schedule is cancelled and removed
The mailbox is no longer part of any warmup pool

Example Payload#

{
  "eventType": "mailbox.warmup.removed",
  "data": {
    "mailboxId": "4165WDY91BMKS6JD341FKQ5XVP19",
    "email": "alice@acmecorp.com",
    "domain": "acmecorp.com",
    "workspaceType": "GOOGLE"
  }
}

Payload Schema#

FieldTypeDescription
eventTypestringAlways "mailbox.warmup.removed"
data.mailboxIdstringUnique identifier for the mailbox
data.emailstringThe mailbox email address
data.domainstringDomain of the mailbox
data.workspaceTypestringWorkspace provider (e.g., "GOOGLE", "MICROSOFT")

Notes#

Warmup removed ≠ Warmup paused: mailbox.warmup.removed indicates warmup has been permanently deleted. Pausing warmup does not fire this event.
No user context on removal: The mailbox.warmup.removed payload does not include userId or userEmail, as the removal may be triggered by the system or an admin action.
Workspace types: Currently supported values for workspaceType are "GOOGLE" and "MICROSOFT".

Next Steps#

Mailbox Warmup
Enable, pause, and bill for warmup on a mailbox.
Mailbox Events
Events for mailbox creation and updates.
Pre-Warmup
Order mailboxes that are already warmed up.
Modified at 2026-08-05 16:12:50
Previous
Prewarmup Events
Next
Error
Built with