InboxKit
  1. Prewarm
InboxKit
  • Introduction
  • Order
    • Place Order
      POST
  • Webhook
    • Status Change Webhook
      POST
  • Account
    • Get account details
      GET
  • Workspaces
    • List workspaces
      GET
    • Get workspace details
      GET
    • Create workspace
      POST
    • Update workspace
      PUT
    • Delete workspace
      DELETE
    • Update workspace webhook
      POST
  • Domains
    • Search available domains
      POST
    • Check if domain is banned from registration
      GET
    • Check domain availability
      GET
    • Register domains
      POST
    • List domains
      POST
    • List assignable domains
      GET
    • Set DMARC policy
      POST
    • Remove DMARC policy
      DELETE
    • Remove domains
      POST
    • Set domain forwarding
      POST
    • Set email forwarding
      POST
    • Remove email forwarding
      DELETE
    • Set catch-all email
      POST
    • Remove catch-all email
      DELETE
    • Get nameservers for domain connection
      POST
    • Check nameservers propagation
      POST
  • Mailboxes
    • List 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
  • DNS
    • Get DNS records
    • Add DNS records
    • Update DNS records
    • Delete DNS records
  • Sequencers
    • Export mailboxes status
    • List sequencer platforms
    • List sequencers
    • Export mailboxes
    • Add sequencer
    • Update sequencer
    • Delete sequencers
  • Billing
    • Get pricing plans
    • Get subscription details
    • Change subscription plan
    • Cancel subscription
    • Get wallet details
    • Add credits to wallet
    • Update auto top-up settings
    • Get billing portal link
  • 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
      POST
    • Search Mailboxes
      POST
    • Buy Prewarmed Mailboxes
      POST
    • Check Order Status
      GET
  1. Prewarm

Buy Prewarmed Mailboxes

Developing
POST
https://api.inboxkit.com/v1/api/prewarm/buy-domain
Maintainer:Not configured
Buy available prewarm mailboxes

Request

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

Body Params application/json

Examples

Responses

🟢200
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.inboxkit.com/v1/api/prewarm/buy-domain' \
--header 'X-Workspace-Id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domains": [
        {
            "domain_id": "507f1f77bcf86cd799439011",
            "consent_screen_url": "https://example.com/consent",
            "mailboxes": [
                {
                    "mailbox_id": "507f191e810c19729de860ea",
                    "username": "john.smith",
                    "first_name": "John",
                    "last_name": "Smith",
                    "profile_picture": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAA..."
                },
                {
                    "mailbox_id": "507f191e810c19729de860eb",
                    "username": "jane.wilson",
                    "first_name": "Jane",
                    "last_name": "Wilson",
                    "profile_picture": "https://example.com/images/jane.jpg"
                }
            ]
        },
        {
            "domain_name": "another-domain.com",
            "mailboxes": [
                {
                    "username": "admin",
                    "first_name": "Admin",
                    "last_name": "User"
                }
            ]
        }
    ],
    "sequencer_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}'
Response Response Example
{
    "error": false,
    "message": "Prewarm order created successfully and queued for processing",
    "data": {
        "order_uid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "order_id": "674a5b8c9d1e2f3a4b5c6d7e",
        "status": "pending",
        "total_domains": 2,
        "total_mailboxes": 3,
        "total_price": 24,
        "domains": [
            {
                "domain_id": "507f1f77bcf86cd799439011",
                "domain_name": "example.com",
                "mailboxes_count": 2,
                "consent_screen_url": "https://example.com/consent"
            },
            {
                "domain_id": "507f1f77bcf86cd799439013",
                "domain_name": "another-domain.com",
                "mailboxes_count": 1,
                "consent_screen_url": null
            }
        ],
        "sequencer_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "buyer": {
            "team_uid": "77659233-b0ba-4b17-8b07-1df219de1ef9",
            "workspace_uid": "workspace-abc-def-ghi"
        }
    }
}
Modified at 2025-10-08 14:03:39
Previous
Search Mailboxes
Next
Check Order Status
Built with