# 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 domain forwarding for specified domains - 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 - Mailboxes [List mailboxes](https://docs.inboxkit.com/list-mailboxes-18118368e0.md): Get a paginated list of mailboxes for the workspace - 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 - 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 [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 - 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-23740009e0.md): - Inbox Placement > Tests [List Tests](https://docs.inboxkit.com/list-tests-23740010e0.md): - Inbox Placement > Tests [Get Test Results](https://docs.inboxkit.com/get-test-results-23740011e0.md): - Inbox Placement > Scheduled Tests [List Scheduled Tests](https://docs.inboxkit.com/list-scheduled-tests-23740012e0.md): - Inbox Placement > Scheduled Tests [Get Scheduled Test](https://docs.inboxkit.com/get-scheduled-test-23740013e0.md): - Inbox Placement > Scheduled Tests [Pause Scheduled Test](https://docs.inboxkit.com/pause-scheduled-test-23740014e0.md): - Inbox Placement > Scheduled Tests [Resume Scheduled Test](https://docs.inboxkit.com/resume-scheduled-test-23740015e0.md): - Inbox Placement > Scheduled Tests [Delete Scheduled Test](https://docs.inboxkit.com/delete-scheduled-test-23740016e0.md):