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
        GET
      • Check domain availability
        GET
      • Register domains
        POST
      • List domains
        POST
      • List assignable domains
        GET
      • Remove domains
        POST
      • Set domain forwarding
        POST
      • Set catch-all email
        POST
      • Remove catch-all email
        DELETE
      • Get nameservers for domain connection
        POST
      • Check nameservers propagation
        POST
      • Check Workspace Availability
        POST
      • Set DMARC Configuration
        POST
      • Remove DMARC Configuration
        DELETE
      • Regenerate Domain Nameservers
        POST
      • Request Domain Renewal
        POST
      • Check Renewal Status
        GET
      • Update Domain Privacy
        POST
      • Update Domain Contact Details
        POST
      • Search available domains
        POST
    • 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
      • Check Payment Status
      • Get subscription details
      • Change subscription plan
      • Cancel subscription
      • Get wallet details
      • Update auto top-up settings
      • Get billing portal link
      • Get Wallet Logs
    • Warmup
      • List Warmup Subscriptions
      • Get Warmup Subscription Details
      • Add Warmup to Mailboxes
      • Pause Warmup for Mailboxes
      • Resume Warmup for Mailboxes
      • Cancel Warmup for Mailboxes
      • Get Warmup Statistics
      • Get Warmup Pricing
    • Client ID Requests
      • Initiate Client ID Request
      • Get Client ID Request Status
      • List Client ID Requests
    • Mailbox Forwarding
      • Setup Email Forwarding
      • Update Email Forwarding
      • Remove Email Forwarding
      • List Forwarding Jobs
    • 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 Activity
        • Get Workspace Daily Stats
        • Get Workspace Campaign Reply Rate
      • Email Insights - Mailbox
        • Get Mailbox Stats
        • Get Mailbox Deliverability
        • Get Mailbox Health
        • Get Mailbox Trends
        • Get Mailbox Activity
        • Get Mailbox Bounce Events
        • 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 First Touch Funnel
        • Get Mailbox Warmup Stats
        • Get Mailbox Auth Failures
        • 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
    • Schemas
      • Schemas
        • WebhookPayload
        • DomainStatusWebhook
        • Tag
        • DomainEventData
        • MailboxStatusWebhook
        • MailboxEventData
        • Domain
        • Mailbox
        • ChangeDetails
        • WebhookResponse
        • ErrorResponse

    Mailbox Operations

    This page lists what you can do with mailboxes and which endpoint to use for each task. Most mailbox endpoints need the X-Workspace-Id header. Each endpoint page lists the headers it needs. New to the API? Start with the Quick Start.

    Create mailboxes#

    Mailboxes are created on a domain in your workspace whose status is active. See Domain Management to add one.
    TaskEndpoint
    Check that a username is freeCheck mailbox availability
    Create mailboxes on your domainsBuy mailboxes
    Buy new domains and their mailboxes in one requestPlace Order
    You can also buy mailboxes that are already warmed up. Find them with Search Domains or Search Mailboxes, confirm with Check Availability, buy with Buy Prewarmed Mailboxes and track the purchase with Check Order Status.

    Track mailboxes and get credentials#

    TaskEndpoint
    Check the status of specific mailboxesCheck mailbox status
    List mailboxes with filtersList mailboxes
    Get one mailboxGet mailbox details
    Get the login details of an active mailboxShow mailbox credentials
    Get a one-time code for two-step loginGenerate TOTP
    Find out why a mailbox failedGet Failure Reason
    To be told when a mailbox changes status, use the mailbox.status_changed webhook event.

    Update mailboxes#

    TaskEndpoint
    Change the name or tagsUpdate mailbox
    Change the profile pictureUpdate mailbox profile picture
    Change the usernameChange username
    Change the passwordChange password
    Add or remove an email signatureAdd or update signature for mailboxes, Delete signature for mailboxes
    Group mailboxes with tagsAssign tags to domains or mailboxes

    Forward incoming email#

    Send a copy of every incoming email to another address.
    TaskEndpoint
    Turn forwarding onSetup Email Forwarding
    Change the destinationUpdate Email Forwarding
    Turn forwarding offRemove Email Forwarding
    Track forwarding changesList Forwarding Jobs

    Warm up mailboxes#

    TaskEndpoint
    See warmup pricesGet Warmup Pricing
    Start warmupAdd Warmup to Mailboxes
    Pause or resume warmupPause Warmup for Mailboxes, Resume Warmup for Mailboxes
    Stop warmupCancel Warmup for Mailboxes
    See warmup subscriptionsList Warmup Subscriptions, Get Warmup Subscription Details
    See warmup resultsGet Warmup Statistics

    Send mailboxes to your sequencer#

    1.
    See the supported platforms and the credentials each one needs with List sequencer platforms.
    2.
    Connect your account with Add sequencer. For Lemlist, you may also need Verify Lemlist OTP.
    3.
    Send mailboxes to it with Export mailboxes.
    4.
    Track each export with Export mailboxes status.
    You can also list, update and delete connected sequencers, and read a sequencer account's tags with Get sequencer tags.

    Approve app access on Google Workspace or Microsoft 365#

    TaskEndpoint
    Ask for consent on a mailboxInitiate Consent Request, Get Consent Request Status, List Consent Requests
    Authorize a client ID for a domainInitiate Client ID Request, Get Client ID Request Status, List Client ID Requests
    Status changes for both are sent as webhook events. See Events: OAuth Consent & Client ID Changes.

    Cancel, restore and renew#

    TaskEndpoint
    Cancel mailboxesCancel mailboxes
    Undo a cancellation (Google Workspace)Uncancel mailboxes
    Set up Google Workspace mailboxes again at renewalResetup mailboxes, Get resetup status
    Reactivate Microsoft 365 and Azure mailboxesReactivate mailboxes (Microsoft 365 / Azure), Re-purchase mailboxes for reactivation (Microsoft 365 / Azure)
    Modified at 2026-09-26 18:28:55
    Previous
    Domain Management
    Next
    Deliverability Monitoring
    Built with