# InboxKit ## Docs - [Welcome to InboxKit](https://docs.inboxkit.com/welcome-to-inboxkit-1056908m0.md): ## API Docs - Order [Place Order](https://docs.inboxkit.com/place-order-20826769e0.md): - Webhook [Status Change Webhook](https://docs.inboxkit.com/status-change-webhook-21400145e0.md): Receives webhook notifications when domain or mailbox status changes - Account [Get account details](https://docs.inboxkit.com/get-account-details-18118380e0.md): Retrieve detailed account information including credits, subscription, and configuration - Workspaces [List workspaces](https://docs.inboxkit.com/list-workspaces-18118362e0.md): Get a list of all workspaces for the authenticated team - Workspaces [Get workspace details](https://docs.inboxkit.com/get-workspace-details-18118363e0.md): Retrieve detailed information for a specific workspace - Workspaces [Create workspace](https://docs.inboxkit.com/create-workspace-18118364e0.md): Create a new workspace with optional webhook url - Workspaces [Update workspace](https://docs.inboxkit.com/update-workspace-18118365e0.md): Update workspace information - Workspaces [Delete workspace](https://docs.inboxkit.com/delete-workspace-18118366e0.md): Delete a workspace permanently - Workspaces [Update workspace webhook](https://docs.inboxkit.com/update-workspace-webhook-18118367e0.md): Update the webhook URL for a workspace - Domains [Search available domains](https://docs.inboxkit.com/search-available-domains-18118346e0.md): Search for available domains based on keywords or domain names with workspace context - Domains [Check if domain is banned from registration](https://docs.inboxkit.com/check-if-domain-is-banned-from-registration-18118347e0.md): Check if a specific domain is banned from registration (no workspace required) - Domains [Check domain availability](https://docs.inboxkit.com/check-domain-availability-18118348e0.md): Check if a specific domain is available for registration (no workspace required) - Domains [Register domains](https://docs.inboxkit.com/register-domains-18118349e0.md): Register domains with contact details and configuration. Supports both new domain creation and updating existing pending payment domains. - Domains [List domains](https://docs.inboxkit.com/list-domains-18118350e0.md): Get a paginated list of domains for the workspace - Domains [List assignable domains](https://docs.inboxkit.com/list-assignable-domains-18118351e0.md): Get domains that can be assigned to mailboxes - Domains [Remove domains](https://docs.inboxkit.com/remove-domains-18118354e0.md): Remove domains from the workspace - Domains [Set domain forwarding](https://docs.inboxkit.com/set-domain-forwarding-18118355e0.md): Configure or remove domain forwarding for specified domains. Pass an empty string for forwarding_url to remove existing forwarding. - Domains [Set catch-all email](https://docs.inboxkit.com/set-catch-all-email-18118358e0.md): Configure catch-all email for specified domains - Domains [Remove catch-all email](https://docs.inboxkit.com/remove-catch-all-email-18118359e0.md): Remove catch-all email configuration for specified domains - Domains [Get nameservers for domain connection](https://docs.inboxkit.com/get-nameservers-for-domain-connection-18118360e0.md): Create Cloudflare nameservers for specified domains - Domains [Check nameservers propagation](https://docs.inboxkit.com/check-nameservers-propagation-18118361e0.md): Check nameserver propagation status for specified domains - Domains [Check Workspace Availability](https://docs.inboxkit.com/check-workspace-availability-24024786e0.md): - Domains [Set DMARC Configuration](https://docs.inboxkit.com/set-dmarc-configuration-24383130e0.md): Set a custom dmarc record - Domains [Remove DMARC Configuration](https://docs.inboxkit.com/remove-dmarc-configuration-24383525e0.md): Reset to default dmarc record - Domains [Regenerate Domain Nameservers](https://docs.inboxkit.com/regenerate-domain-nameservers-26511942e0.md): ## Regenerate Domain Nameservers - Cloudflare Domains [Connect Cloudflare Domains](https://docs.inboxkit.com/connect-cloudflare-domains-28724829e0.md): - Cloudflare Domains [List Connected Cloudflare Domains](https://docs.inboxkit.com/list-connected-cloudflare-domains-28724830e0.md): - Cloudflare Domains [Get Domain Details](https://docs.inboxkit.com/get-domain-details-28724831e0.md): - Cloudflare Domains [Disconnect Cloudflare Domains](https://docs.inboxkit.com/disconnect-cloudflare-domains-28724832e0.md): - Cloudflare Domains [List Cloudflare Zones](https://docs.inboxkit.com/list-cloudflare-zones-28724833e0.md): - Mailboxes [List mailboxes](https://docs.inboxkit.com/list-mailboxes-18118368e0.md): Get a paginated list of mailboxes for the workspace - Mailboxes [Add or update signature for mailboxes](https://docs.inboxkit.com/add-or-update-signature-for-mailboxes-25568630e0.md): Add a signature to multiple mailboxes. If a signature already exists for a mailbox, it will be updated. If not, a new signature will be created. - Mailboxes [Delete signature for mailboxes](https://docs.inboxkit.com/delete-signature-for-mailboxes-25568634e0.md): Deletes signatures for multiple mailboxes. Returns which signatures were deleted, which mailboxes had no signatures, and which mailbox UIDs were invalid. - Mailboxes [Show mailbox credentials](https://docs.inboxkit.com/show-mailbox-credentials-18118369e0.md): Retrieve credentials for a specific mailbox , either uid or email required - Mailboxes [Get mailbox details](https://docs.inboxkit.com/get-mailbox-details-18118370e0.md): Retrieve detailed information for a specific mailbox - Mailboxes [Buy mailboxes](https://docs.inboxkit.com/buy-mailboxes-18118371e0.md): Purchase mailboxes for specified domains - Mailboxes [Check mailbox status](https://docs.inboxkit.com/check-mailbox-status-18118372e0.md): Check the status of specified mailboxes - Mailboxes [Cancel mailboxes](https://docs.inboxkit.com/cancel-mailboxes-18118373e0.md): Schedule specified mailboxes for cancellation - Mailboxes [Update mailbox](https://docs.inboxkit.com/update-mailbox-18118374e0.md): Update mailbox information - Mailboxes [Update mailbox profile picture](https://docs.inboxkit.com/update-mailbox-profile-picture-18118375e0.md): Update the profile picture for a specific mailbox - Mailboxes [Generate TOTP](https://docs.inboxkit.com/generate-totp-18118376e0.md): Generate a TOTP (Time-based One-Time Password) for a mailbox - Mailboxes [Change username](https://docs.inboxkit.com/change-username-18118377e0.md): Change the username for a mailbox - Mailboxes [Change password](https://docs.inboxkit.com/change-password-18118378e0.md): Change the password for a mailbox - Mailboxes [Check mailbox availability](https://docs.inboxkit.com/check-mailbox-availability-18118379e0.md): Check if a mailbox username is available - Mailboxes [Get Failure Reason](https://docs.inboxkit.com/get-failure-reason-27154222e0.md): - Mailboxes [Uncancel mailboxes](https://docs.inboxkit.com/uncancel-mailboxes-28589059e0.md): Reactivate mailboxes that are scheduled for cancellation. Only Google Workspace mailboxes within the 10-day recovery window (from the admin mailbox renewal date) can be uncancelled. - DNS [Get DNS records](https://docs.inboxkit.com/get-dns-records-18118381e0.md): Retrieve DNS records for a specific domain - DNS [Add DNS records](https://docs.inboxkit.com/add-dns-records-18118382e0.md): Add new DNS records to a domain - DNS [Update DNS records](https://docs.inboxkit.com/update-dns-records-18118383e0.md): Update existing DNS records for a domain - DNS [Delete DNS records](https://docs.inboxkit.com/delete-dns-records-18118384e0.md): Delete specific DNS records or all records for a domain - Sequencers [Export mailboxes status](https://docs.inboxkit.com/export-mailboxes-status-18264097e0.md): - Sequencers [List sequencer platforms](https://docs.inboxkit.com/list-sequencer-platforms-18118385e0.md): Get a list of supported sequencer platforms with their configuration details - Sequencers [Get sequencer tags](https://docs.inboxkit.com/get-sequencer-tags-25568581e0.md): Get list of available tags for a sequencer platform. Requires a valid API key and the platform must support tags. - Sequencers [List sequencers](https://docs.inboxkit.com/list-sequencers-18118386e0.md): Get a paginated list of sequencers for the workspace with optional filtering - Sequencers [Export mailboxes](https://docs.inboxkit.com/export-mailboxes-18118387e0.md): Connect sequencers to specified mailboxes (export sequencers for use) - Sequencers [Add sequencer](https://docs.inboxkit.com/add-sequencer-18118388e0.md): Add a new sequencer configuration to the workspace - Sequencers [Update sequencer](https://docs.inboxkit.com/update-sequencer-18118389e0.md): Update an existing sequencer configuration - Sequencers [Delete sequencers](https://docs.inboxkit.com/delete-sequencers-18118390e0.md): Delete one or more sequencers by their UIDs - Billing [Get pricing plans](https://docs.inboxkit.com/get-pricing-plans-18118391e0.md): Retrieve all available pricing plans with upgrade/downgrade options relative to current subscription - Billing [Get subscription details](https://docs.inboxkit.com/get-subscription-details-18118392e0.md): Retrieve current subscription information and available pricing plans - Billing [Change subscription plan](https://docs.inboxkit.com/change-subscription-plan-18118393e0.md): Change to a different subscription plan or create new subscription - Billing [Cancel subscription](https://docs.inboxkit.com/cancel-subscription-18118394e0.md): Cancel the current active subscription - Billing [Get wallet details](https://docs.inboxkit.com/get-wallet-details-18118395e0.md): Retrieve wallet balance and credit information - Billing [Add credits to wallet](https://docs.inboxkit.com/add-credits-to-wallet-18118396e0.md): Generate payment link to add credits to wallet balance - Billing [Update auto top-up settings](https://docs.inboxkit.com/update-auto-top-up-settings-18118397e0.md): Configure automatic wallet top-up when credits drop below threshold - Billing [Get billing portal link](https://docs.inboxkit.com/get-billing-portal-link-18118398e0.md): Generate a link to Stripe's customer billing portal for managing payment methods and billing history - Warmup [List Warmup Subscriptions](https://docs.inboxkit.com/list-warmup-subscriptions-28170226e0.md): - Warmup [Get Warmup Subscription Details](https://docs.inboxkit.com/get-warmup-subscription-details-28170227e0.md): - Warmup [Add Warmup to Mailboxes](https://docs.inboxkit.com/add-warmup-to-mailboxes-28170228e0.md): - Warmup [Pause Warmup for Mailboxes](https://docs.inboxkit.com/pause-warmup-for-mailboxes-28170229e0.md): - Warmup [Resume Warmup for Mailboxes](https://docs.inboxkit.com/resume-warmup-for-mailboxes-28170230e0.md): - Warmup [Cancel Warmup for Mailboxes](https://docs.inboxkit.com/cancel-warmup-for-mailboxes-28170231e0.md): - Warmup [Get Warmup Statistics](https://docs.inboxkit.com/get-warmup-statistics-28170232e0.md): - Warmup [Get Warmup Pricing](https://docs.inboxkit.com/get-warmup-pricing-28170233e0.md): - Client ID Requests [Initiate Client ID Request](https://docs.inboxkit.com/initiate-client-id-request-24032375e0.md): - Client ID Requests [Get Client ID Request Status](https://docs.inboxkit.com/get-client-id-request-status-24032376e0.md): - Client ID Requests [List Client ID Requests](https://docs.inboxkit.com/list-client-id-requests-24032377e0.md): - Mailbox Forwarding [Setup Email Forwarding](https://docs.inboxkit.com/setup-email-forwarding-24243964e0.md): - Mailbox Forwarding [Update Email Forwarding](https://docs.inboxkit.com/update-email-forwarding-24243965e0.md): - Mailbox Forwarding [Remove Email Forwarding](https://docs.inboxkit.com/remove-email-forwarding-24243966e0.md): - Mailbox Forwarding [List Forwarding Jobs](https://docs.inboxkit.com/list-forwarding-jobs-24243967e0.md): - Consent Request [Initiate Consent Request](https://docs.inboxkit.com/initiate-consent-request-21455088e0.md): Create a new consent request for a mailbox. Can identify mailbox by either UID or username+domain combination. - Consent Request [Get Consent Request Status](https://docs.inboxkit.com/get-consent-request-status-21455089e0.md): Retrieve the current status of a consent request - Consent Request [List Consent Requests](https://docs.inboxkit.com/list-consent-requests-21455090e0.md): Retrieve a list of consent requests with optional filtering - Tags [Assign tags to domains or mailboxes](https://docs.inboxkit.com/assign-tags-to-domains-or-mailboxes-21553693e0.md): Bulk assign, remove, or set tags for multiple domains or mailboxes. Tags are workspace-specific and isolated. - Tags [Get all tags](https://docs.inboxkit.com/get-all-tags-21553694e0.md): Retrieve all tags for the workspace. Tags are isolated per workspace. - Tags [Create a new tag](https://docs.inboxkit.com/create-a-new-tag-21553695e0.md): Create a new tag for the workspace. Tag names can be duplicated across workspaces but each will have a unique UID. - Tags [Delete a tag](https://docs.inboxkit.com/delete-a-tag-21553696e0.md): Delete a tag and remove it from all associated entities. Only affects the tag in the current workspace. - Prewarm [Search Domains](https://docs.inboxkit.com/search-domains-22159198e0.md): Search from all available prewarm domains - Prewarm [Search Mailboxes](https://docs.inboxkit.com/search-mailboxes-22159242e0.md): Search from all available prewarm mailboxes - Prewarm [Buy Prewarmed Mailboxes](https://docs.inboxkit.com/buy-prewarmed-mailboxes-22248586e0.md): Buy available prewarm mailboxes - Prewarm [Check Order Status](https://docs.inboxkit.com/check-order-status-22431641e0.md): Check Order Status - Prewarm [Check Availability](https://docs.inboxkit.com/check-availability-23254214e0.md): Check if prewarm domain is still available - Inbox Placement > Tests [Create Test](https://docs.inboxkit.com/create-test-24618276e0.md): - Inbox Placement > Tests [List Tests](https://docs.inboxkit.com/list-tests-24618277e0.md): - Inbox Placement > Tests [Get Test Results](https://docs.inboxkit.com/get-test-results-24618278e0.md): - Inbox Placement > Scheduled Tests [List Scheduled Tests](https://docs.inboxkit.com/list-scheduled-tests-24618279e0.md): - Inbox Placement > Scheduled Tests [Get Scheduled Test](https://docs.inboxkit.com/get-scheduled-test-24618280e0.md): - Inbox Placement > Scheduled Tests [Pause Scheduled Test](https://docs.inboxkit.com/pause-scheduled-test-24618281e0.md): - Inbox Placement > Scheduled Tests [Resume Scheduled Test](https://docs.inboxkit.com/resume-scheduled-test-24618282e0.md): - Inbox Placement > Scheduled Tests [Delete Scheduled Test](https://docs.inboxkit.com/delete-scheduled-test-24618283e0.md): - InfraGuard > InfraGuard - Subscriptions [List protected domains](https://docs.inboxkit.com/list-protected-domains-28226889e0.md): - InfraGuard > InfraGuard - Subscriptions [Get subscription details](https://docs.inboxkit.com/get-subscription-details-28226890e0.md): - InfraGuard > InfraGuard - Subscriptions [Enable InfraGuard for domains](https://docs.inboxkit.com/enable-infraguard-for-domains-28226891e0.md): - InfraGuard > InfraGuard - Subscriptions [Cancel InfraGuard for domains](https://docs.inboxkit.com/cancel-infraguard-for-domains-28226892e0.md): - InfraGuard > InfraGuard - Subscriptions [Get workspace statistics](https://docs.inboxkit.com/get-workspace-statistics-28226893e0.md): - InfraGuard > InfraGuard - Subscriptions [Get pricing info](https://docs.inboxkit.com/get-pricing-info-28226894e0.md): - InfraGuard > InfraGuard - Monitoring [Get blacklist check history](https://docs.inboxkit.com/get-blacklist-check-history-28226895e0.md): - InfraGuard > InfraGuard - Monitoring [Get DNS check history](https://docs.inboxkit.com/get-dns-check-history-28226896e0.md): - InfraGuard > InfraGuard - Monitoring [Get current bounce metrics](https://docs.inboxkit.com/get-current-bounce-metrics-28226897e0.md): - InfraGuard > InfraGuard - Monitoring [Get bounce check history](https://docs.inboxkit.com/get-bounce-check-history-28226898e0.md): - InfraGuard > InfraGuard - Settings [Update subscription settings](https://docs.inboxkit.com/update-subscription-settings-28226899e0.md): - InfraGuard > InfraGuard - Settings [Trigger manual check](https://docs.inboxkit.com/trigger-manual-check-28226900e0.md): - InfraGuard > InfraGuard - Alerts [List alerts](https://docs.inboxkit.com/list-alerts-28226901e0.md): - InfraGuard > InfraGuard - Alerts [Acknowledge an alert](https://docs.inboxkit.com/acknowledge-an-alert-28226902e0.md): - InfraGuard > InfraGuard - Alerts [Resolve an alert](https://docs.inboxkit.com/resolve-an-alert-28226903e0.md): - InfraGuard > InfraGuard - Action Items [List action items](https://docs.inboxkit.com/list-action-items-28226904e0.md): - InfraGuard > InfraGuard - Action Items [Get action item statistics](https://docs.inboxkit.com/get-action-item-statistics-28226905e0.md): - InfraGuard > InfraGuard - Action Items [Resolve an action item](https://docs.inboxkit.com/resolve-an-action-item-28226906e0.md): - InfraGuard > InfraGuard - Action Items [Dismiss an action item](https://docs.inboxkit.com/dismiss-an-action-item-28226907e0.md): - Email Insight > Email Insights - Workspace [Get Workspace Overview](https://docs.inboxkit.com/get-workspace-overview-30003613e0.md): Get a high-level analytics overview for the workspace including total sent, received, bounce rate, reply rate, and mailbox health distribution. - Email Insight > Email Insights - Workspace [Get Mailboxes Health](https://docs.inboxkit.com/get-mailboxes-health-30003614e0.md): Get all mailboxes in the workspace with their health status, bounce rate, reply rate, and 7-day activity metrics. Supports filtering by health status, platform, tags, date range, and custom sorting. - Email Insight > Email Insights - Workspace [Get High Bounce Mailboxes](https://docs.inboxkit.com/get-high-bounce-mailboxes-30003615e0.md): Get mailboxes that exceed a bounce rate threshold. Useful for identifying mailboxes with deliverability problems that need attention. - Email Insight > Email Insights - Workspace [Get Workspace Activity](https://docs.inboxkit.com/get-workspace-activity-30003616e0.md): Get recent email activity events across all mailboxes in the workspace. - Email Insight > Email Insights - Mailbox [Get Mailbox Stats](https://docs.inboxkit.com/get-mailbox-stats-30003617e0.md): Get comprehensive statistics for a specific mailbox including total sent, received, bounced, replied, rates, and daily activity chart data. - Email Insight > Email Insights - Mailbox [Get Mailbox Deliverability](https://docs.inboxkit.com/get-mailbox-deliverability-30003618e0.md): Get deliverability metrics for a specific mailbox including bounce rates (hard/soft), reply rate, and delivery rate. - Email Insight > Email Insights - Mailbox [Get Mailbox Health](https://docs.inboxkit.com/get-mailbox-health-30003619e0.md): Get the current health status of a specific mailbox, including health classification (healthy, warning, critical, etc.) and key metrics. - Email Insight > Email Insights - Mailbox [Get Mailbox Trends](https://docs.inboxkit.com/get-mailbox-trends-30003620e0.md): Get email trends for a specific mailbox over a configurable time period. Shows how sent, received, and bounce volumes change over time. - Email Insight > Email Insights - Mailbox [Get Mailbox Activity](https://docs.inboxkit.com/get-mailbox-activity-30003621e0.md): Get a paginated list of email activity events for a specific mailbox, optionally filtered by event type. - Email Insight > Email Insights - Mailbox [Get Mailbox Bounce Events](https://docs.inboxkit.com/get-mailbox-bounce-events-30003622e0.md): Get detailed bounce events for a specific mailbox, including bounce type (hard/soft), recipient, reason, and timestamp. Supports filtering by bounce type and pagination. - Email Insight > Email Insights - Mailbox [Get Mailbox Top Recipients](https://docs.inboxkit.com/get-mailbox-top-recipients-30003623e0.md): Get the top recipients for a specific mailbox ranked by number of emails sent. - Email Insight > Email Insights - Mailbox [Get Mailbox Top Recipient Domains](https://docs.inboxkit.com/get-mailbox-top-recipient-domains-30003624e0.md): Get the top recipient domains for a specific mailbox ranked by number of emails sent. - Email Insight > Email Insights - Mailbox [Get Mailbox Message Breakdown](https://docs.inboxkit.com/get-mailbox-message-breakdown-30003625e0.md): Get a breakdown of messages for a specific mailbox by type/category over the specified period. - Email Insight > Email Insights - Mailbox [Get Mailbox Subject Analysis](https://docs.inboxkit.com/get-mailbox-subject-analysis-30003626e0.md): Get subject line keyword analysis for a specific mailbox. Identifies common keywords/phrases in email subjects, optionally filtered by direction (sent/received/all). ## Schemas - Schemas [WebhookPayload](https://docs.inboxkit.com/webhookpayload-9399674d0.md): - Schemas [DomainStatusWebhook](https://docs.inboxkit.com/domainstatuswebhook-9399990d0.md): - Schemas [Tag](https://docs.inboxkit.com/tag-9495709d0.md): - Schemas [DomainEventData](https://docs.inboxkit.com/domaineventdata-9399675d0.md): - Schemas [MailboxStatusWebhook](https://docs.inboxkit.com/mailboxstatuswebhook-9399991d0.md): - Schemas [MailboxEventData](https://docs.inboxkit.com/mailboxeventdata-9399676d0.md): - Schemas [Domain](https://docs.inboxkit.com/domain-9399677d0.md): - Schemas [Mailbox](https://docs.inboxkit.com/mailbox-9399678d0.md): - Schemas [ChangeDetails](https://docs.inboxkit.com/changedetails-9399992d0.md): - Schemas [WebhookResponse](https://docs.inboxkit.com/webhookresponse-9399993d0.md): - Schemas [ErrorResponse](https://docs.inboxkit.com/errorresponse-9399994d0.md):