### Header Parameter Example Source: https://docs.inboxkit.com/get-mailboxes-health-30003614e0 Example for the required X-Workspace-Id header. ```text c145ecc0-6487-49c5-bbbe-46748495cfd2 ``` -------------------------------- ### Get Workspace Overview Request Source: https://docs.inboxkit.com/get-workspace-overview-30003613e0 Example cURL command to retrieve workspace overview data using the required X-Workspace-Id header and Authorization bearer token. ```bash curl --location 'https://api.inboxkit.com/v1/api/email-insights/workspace/overview?period=30' \ --header 'X-Workspace-Id: c145ecc0-6487-49c5-bbbe-46748495cfd2' \ --header 'Authorization: Bearer ' ``` -------------------------------- ### Query Parameter Examples Source: https://docs.inboxkit.com/get-mailboxes-health-30003614e0 Examples for page and limit query parameters. ```text 1 ``` ```text 100 ``` -------------------------------- ### Example 1: Instantly Sequencer Configuration Source: https://docs.inboxkit.com/add-sequencer-18118388e0 An example configuration for adding a sequencer on the Instantly platform. ```json { "name": "My Instantly Account", "platform": "instantly", "sequencer_login": "user@example.com", "sequencer_password": "StrongPass@1", "sequencer_workspace": "instantly_workspace_name" } ``` -------------------------------- ### Example 2: Masterinbox Sequencer Configuration Source: https://docs.inboxkit.com/add-sequencer-18118388e0 An example configuration for adding a sequencer on the Masterinbox platform. ```json { "name": "imrudra", "platform": "masterinbox", "sequencer_login": "imrudra.me@gmail.com", "sequencer_password": "StrongPass@1", "workspace_id": "im-rudra-1111" } ``` -------------------------------- ### Webhook Request Example Source: https://docs.inboxkit.com/webhook-integration-signature-verification-42681032e0 A cURL request example demonstrating the headers and JSON payload for a domain status change event. ```shell curl --location 'https://api.inboxkit.com/webhook' \ --header 'X-InboxKit-Signature: sha256=b0344c61d8db38e0f469e85fc6e8c055e0742e8d9a9c5a9e8e4d3f7c5a8b9c0d' \ --header 'X-InboxKit-Event: domain.status_changed' \ --header 'X-InboxKit-Timestamp: 2024-01-10T15:30:45.123Z' \ --header 'User-Agent: InboxKit-Webhook/1.0' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "event": "domain.status_changed", "timestamp": "2024-01-10T15:30:45.123Z", "team_id": "ABC-123-DEF-TEAM", "team_name": "Marketing Team", "data": { "domain": { "uid": "ABC-123-DEF-DOMAIN", "name": "yourdomain.com", "tld": "com", "status": "active", "previous_status": "pending_payment", "dns_propagation_status": "propagated", "nameservers": [ "ns1.inboxkit.com", "ns2.inboxkit.com" ], "renewal_date": "2025-01-10T00:00:00.000Z", "renewal_status": "na", "registration_years": 1, "registration_date": "2024-01-10T00:00:00.000Z", "price": 12.99, "connection_type": "purchased", "forwarding_url": "", "forwarding_email": "", "forwarding_status": "", "enable_mask_forwarding": false, "dmarc_email": "", "catch_all_email": "", "assigned_mailboxes": 0, "available_mailboxes": 50, "tags": [ "production" ] }, "metadata": { "updated_at": "2024-01-10T15:30:45.123Z", "workspace_id": "ABC-123-DEF-WORKSPACE" } } }' ``` -------------------------------- ### Request Body Domains Example Source: https://docs.inboxkit.com/regenerate-domain-nameservers-26511942e0 Example of the domains array parameter for the request body. ```json ["example.com","mycompany.net"] ``` -------------------------------- ### Request Body UIDs Example Source: https://docs.inboxkit.com/regenerate-domain-nameservers-26511942e0 Example of the uids array parameter for the request body. ```json ["d1a2b3c4-5678-90ab-cdef-1234567890ab","e2f3a4b5-6789-01bc-defg-2345678901cd"] ``` -------------------------------- ### Success Response Example Source: https://docs.inboxkit.com/update-domain-contact-details-42052159e0 Example of a successful 200 response indicating the domain contacts were updated. ```json { "error": false, "message": "Domain contacts updated successfully.", "data": { "domain": "example.com", "status": "updated" } } ``` -------------------------------- ### OpenAPI Request Body Example Source: https://docs.inboxkit.com/buy-prewarmed-mailboxes-22248586e0 Example structure for the request body, including domain IDs, mailbox user details, and the sequencer UID. ```yaml 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 ``` -------------------------------- ### Consent Request Webhook Examples Source: https://docs.inboxkit.com/events-oauth-consent-client-id-changes-33086447e0 JSON examples for different consent request status changes: completed, pending, and errored. ```json Consent_Completed: value: event: consent_request.status_changed timestamp: '2024-01-10T17:05:00.000Z' team_id: ABC-123-DEF-TEAM team_name: Marketing Team data: consent_request: uid: ABC-123-DEF-CONSENT-REQUEST status: completed previous_status: pending consent_url: >- https://accounts.google.com/o/oauth2/v2/auth?client_id=...&scope=... status_text: Consent granted status_reason: '' retry_count: 0 max_retries: 3 completed_at: '2024-01-10T17:05:00.000Z' metadata: updated_at: '2024-01-10T17:05:00.000Z' workspace_id: ABC-123-DEF-WORKSPACE workspace_uid: ABC-123-DEF-WORKSPACE-UID mailbox_id: ABC-123-DEF-MAILBOX-ID mailbox_uid: ABC-123-DEF-MAILBOX-UID ``` ```json Consent_Pending: value: event: consent_request.status_changed timestamp: '2024-01-10T17:00:00.000Z' team_id: ABC-123-DEF-TEAM team_name: Marketing Team data: consent_request: uid: ABC-123-DEF-CONSENT-REQUEST status: pending previous_status: queued consent_url: >- https://accounts.google.com/o/oauth2/v2/auth?client_id=123...&scope=https%3A%2F%2Fmail.google.com%2F status_text: Waiting for user to complete consent status_reason: '' retry_count: 0 max_retries: 3 completed_at: null metadata: updated_at: '2024-01-10T17:00:00.000Z' workspace_id: ABC-123-DEF-WORKSPACE workspace_uid: ABC-123-DEF-WORKSPACE-UID mailbox_id: ABC-123-DEF-MAILBOX-ID mailbox_uid: ABC-123-DEF-MAILBOX-UID ``` ```json Consent_Errored: value: event: consent_request.status_changed timestamp: '2024-01-10T17:10:00.000Z' team_id: ABC-123-DEF-TEAM team_name: Marketing Team data: consent_request: uid: ABC-123-DEF-CONSENT-REQUEST status: errored previous_status: pending consent_url: >- https://accounts.google.com/o/oauth2/v2/auth?client_id=...&scope=... status_text: User denied access status_reason: access_denied retry_count: 1 max_retries: 3 ``` -------------------------------- ### Authorization Header Example Source: https://docs.inboxkit.com/get-scheduled-test-24618280e0 Example of the required Authorization header format for protected API requests. ```text Authorization: Bearer ******************** ``` -------------------------------- ### Get Mailbox Health Response Source: https://docs.inboxkit.com/get-mailbox-health-30003619e0 Example JSON response for a successful mailbox health request. ```json { "success": true, "data": { "mailbox_id": "12b5275a-0fb5-44c8-8b9f-f07368950f0e", "status": "healthy", "total_7d": 293, "total_30d": 1628, "last_event_at": "2026-08-13T09:41:22Z", "first_event_at": "2026-07-15T08:12:44Z", "bounce_rate_30d": 0.0141 } } ``` -------------------------------- ### Get Scheduled Test Response Source: https://docs.inboxkit.com/get-scheduled-test-24618280e0 Example JSON response structure for a successful scheduled test retrieval. ```json { "success": true, "schedule": { "id": "string", "test_name": "string", "frequency": "once", "status": "active", "next_run_at": "2019-08-24T14:15:22.123Z", "last_run_at": "2019-08-24T14:15:22.123Z", "total_runs": 0, "sender_mailbox_ids": [ "string" ], "created_at": "2019-08-24T14:15:22.123Z", "updated_at": "2019-08-24T14:15:22.123Z" } } ``` -------------------------------- ### Get resetup status response example Source: https://docs.inboxkit.com/get-resetup-status-35638474e0 The JSON structure returned by the API when a resetup job is found. ```json { "error": false, "resetup": { "uid": "string", "domain": "string", "domain_name": "string", "team": "string", "workspace": "string", "status": "pending", "createdAt": "2019-08-24T14:15:22.123Z", "updatedAt": "2019-08-24T14:15:22.123Z" } } ``` -------------------------------- ### Get Mailbox Body Templates Request Source: https://docs.inboxkit.com/get-mailbox-body-templates-36878639e0 Example cURL request to retrieve body templates for a specific mailbox UID. ```bash curl --location 'https://api.inboxkit.com/v1/api/email-insights/mailbox/12b5275a-0fb5-44c8-8b9f-f07368950f0e/body-templates?period=30&limit=30' \ --header 'X-Workspace-Id: c145ecc0-6487-49c5-bbbe-46748495cfd2' \ --header 'Authorization: Bearer ' ``` -------------------------------- ### Get Sequencer Tags Response Source: https://docs.inboxkit.com/get-sequencer-tags-25568581e0 Example JSON response returned upon a successful request, containing the list of available tags. ```json { "error": false, "tags": [ { "id": "tag_123456", "name": "Sales" } ] } ``` -------------------------------- ### Nameservers creation response example Source: https://docs.inboxkit.com/get-nameservers-for-domain-connection-18118360e0 This JSON object represents a successful 200 OK response, containing the domain, assigned nameservers, and a unique identifier. ```json { "error": false, "message": "Nameservers created successfully", "result": [ { "domain": "example.com", "nameservers": [ "ns1.cloudflare.com", "ns2.cloudflare.com" ], "uid": "string" } ] } ``` -------------------------------- ### Get Mailbox Message Breakdown Request Source: https://docs.inboxkit.com/get-mailbox-message-breakdown-30003625e0 Example cURL request to retrieve message breakdown data for a specific mailbox UID. ```Shell curl --location 'https://api.inboxkit.com/v1/api/email-insights/mailbox/12b5275a-0fb5-44c8-8b9f-f07368950f0e/message-breakdown?period=30' \ --header 'X-Workspace-Id: c145ecc0-6487-49c5-bbbe-46748495cfd2' \ --header 'Authorization: Bearer ' ``` -------------------------------- ### Warmup Pricing Success Response Source: https://docs.inboxkit.com/get-warmup-pricing-28170233e0 A successful 200 OK response returns the pricing details, currency, billing cycle, and subscription statistics for the workspace. ```json { "error": false, "price_per_mailbox": 3, "currency": "USD", "billing_cycle": "monthly", "active_subscriptions": 20, "pending_subscriptions": 3, "total_subscriptions": 25, "monthly_cost": 60 } ``` -------------------------------- ### 200 OK Wallet Response Source: https://docs.inboxkit.com/register-domains-18118349e0 Example JSON response returned when domain registration is initiated successfully using wallet balance. ```json { "error": false, "message": "Domains registration initiated successfully", "domains_count": 2, "total_cost": 49.96, "payment_type": "wallet", "contact_details": { "first_name": "Alice", "last_name": "Doe", "email": "alice@example.com", "phone": "(997) 416-8688", "organization": "incididunt aliqua reprehenderit Duis sint", "address_line1": "Alabama Lake Lillieberg Clay County 422 Mill Road Apt. 612", "address_line2": "Oregon Brentstad Douglas County 7360 Connelly Crest Apt. 381", "city": "Binscester", "state": "Arkansas", "country": "Egypt", "postal_code": "94102-3898" }, "domain_uids": [ "dom_aaa", "dom_bbb" ] } ``` -------------------------------- ### Get Mailbox Reply Time Heatmap Request Source: https://docs.inboxkit.com/get-mailbox-reply-time-heatmap-36878631e0 Example cURL request to retrieve the reply time heatmap for a specific mailbox UID. ```shell curl --location 'https://api.inboxkit.com/v1/api/email-insights/mailbox/12b5275a-0fb5-44c8-8b9f-f07368950f0e/reply-time-heatmap?period=30' \ --header 'X-Workspace-Id: c145ecc0-6487-49c5-bbbe-46748495cfd2' \ --header 'Authorization: Bearer ' ``` -------------------------------- ### POST /v1/api/sequencers/add Source: https://docs.inboxkit.com/add-sequencer-18118388e0 Connects a new sequencer account to your workspace. Requires platform-specific credentials and settings. ```APIDOC ## POST /v1/api/sequencers/add ### Description Connect a new sequencer account (e.g., Instantly, Smartlead, Lemlist) to your workspace. The required fields vary by platform; consult the List sequencer platforms endpoint for the authoritative list of required fields for your chosen platform. ### Method POST ### Endpoint /v1/api/sequencers/add ### Parameters #### Header Parameters - **X-Workspace-Id** (string) - Required - ID of the workspace this request applies to. #### Request Body - **name** (string) - Optional - Display name for the sequencer in your workspace. - **platform** (string) - Optional - Sequencer platform identifier (e.g., instantly, smartlead, lemlist). - **sequencer_login** (string) - Optional - Username or email for the sequencer account. - **sequencer_password** (string) - Optional - Password for the sequencer account. - **sequencer_workspace** (string) - Optional - Workspace or organization name on the sequencer. - **workspace_id** (string) - Optional - Workspace identifier on the sequencer. - **app_url** (string) - Optional - Application URL for self-hosted instances. - **client_id** (string) - Optional - OAuth client ID from your sequencer account. - **api_key** (string) - Optional - API key for the sequencer account. ### Response #### Success Response (201) - Returns the created Sequencer record. #### Success Response (202) - Returns `{ status: 'verification_required', verification_id, sequencer_email }` if Lemlist requires OTP/magic-link verification. ``` -------------------------------- ### Get Mailbox Health Request Source: https://docs.inboxkit.com/get-mailbox-health-30003619e0 Example cURL command to retrieve mailbox health data. Replace with your actual bearer token. ```shell curl --location 'https://api.inboxkit.com/v1/api/email-insights/mailbox/12b5275a-0fb5-44c8-8b9f-f07368950f0e/health' \ --header 'X-Workspace-Id: c145ecc0-6487-49c5-bbbe-46748495cfd2' \ --header 'Authorization: Bearer ' ``` -------------------------------- ### Pricing plans API response example Source: https://docs.inboxkit.com/get-pricing-plans-18118391e0 The response returns an array of available plans and the details of the currently active plan. ```json { "plans": [ { "uid": "plan_123456", "name": "Professional", "cycle": "monthly", "pricing": 29.99, "features": [ "Unlimited domains" ], "active": true, "current": false, "upgrade": true, "downgrade": false } ], "activePlan": { "uid": "string", "name": "string", "cycle": "string", "pricing": 0 } } ``` -------------------------------- ### Get Sequencer Tags Request Source: https://docs.inboxkit.com/get-sequencer-tags-25568581e0 Example cURL request to retrieve tags for a sequencer account. Ensure the X-Workspace-Id and Authorization headers are correctly set. ```bash curl --location 'https://api.inboxkit.com/v1/api/sequencers/get-sequencers-tags' \ --header 'X-Workspace-Id;' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "platform": "instantly", "api_key": "sk_test_123456789" }' ``` -------------------------------- ### Get Mailbox Stats Success Response Source: https://docs.inboxkit.com/get-mailbox-stats-30003617e0 Example JSON response for a successful 200 status code, containing event counts and calculated rates. ```json { "success": true, "data": { "total": 1628, "sent": 1240, "received": 388, "reply": 96, "auto_reply": 31, "bounce_hard": 14, "bounce_soft": 9, "warmup_sent": 620, "warmup_received": 574, "first_event_at": "2026-07-15T08:12:44Z", "last_event_at": "2026-08-13T09:41:22Z", "bounce_rate": 0.0141, "response_rate": 0.2474 } } ``` -------------------------------- ### Get Mailbox Recipient ESP Breakdown Request Source: https://docs.inboxkit.com/get-mailbox-recipient-esp-breakdown-36878638e0 Example cURL request to retrieve recipient ESP breakdown data for a specific mailbox UID. ```shell curl --location 'https://api.inboxkit.com/v1/api/email-insights/mailbox/12b5275a-0fb5-44c8-8b9f-f07368950f0e/recipient-esp-breakdown?period=30' \ --header 'X-Workspace-Id: c145ecc0-6487-49c5-bbbe-46748495cfd2' \ --header 'Authorization: Bearer ' ``` -------------------------------- ### Initiate Client ID Request Success Response Source: https://docs.inboxkit.com/initiate-client-id-request-42762342e0 Example JSON response returned upon a successful initiation of a client ID request. ```json { "error": false, "message": "Client ID request initiated successfully", "data": { "uid": "req-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "queued", "domain_name": "example.com", "client_id": "123456789-abcdefghijklmnop.apps.googleusercontent.com", "platform": "GOOGLE", "delegated": true, "scopes": [ "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/admin.directory.user" ], "app_roles": [ "Mail.Send" ], "created_at": "2025-01-15T10:00:00.000Z" } } ``` -------------------------------- ### Get DNS records response example Source: https://docs.inboxkit.com/get-dns-records-18118381e0 The JSON response structure returned upon a successful request, containing the status and the list of DNS records. ```json { "error": false, "message": "DNS records retrieved successfully", "dns_record": { "uid": "string", "records": [ { "host": "www", "type": "A", "value": "192.168.1.1", "ttl": 3600, "status": "pending", "priority": 0, "proxied": false } ] } } ``` -------------------------------- ### List Warmup Subscriptions Request Source: https://docs.inboxkit.com/list-warmup-subscriptions-28170226e0 Example cURL request to list warmup subscriptions. Ensure you replace with your actual bearer token and provide the X-Workspace-Id header. ```bash curl --location 'https://api.inboxkit.com/v1/api/warmup/list' \ --header 'X-Workspace-Id;' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "page": 1, "limit": 10, "status": "active", "include_cancelled": false }' ``` -------------------------------- ### Get Mailbox Subject Analysis Response Source: https://docs.inboxkit.com/get-mailbox-subject-analysis-30003626e0 Example JSON response for a successful 200 status code, containing keyword counts and subject length statistics. ```json { "success": true, "data": { "period_days": 30, "common_keywords": [ { "keyword": "question", "count": 34 }, { "keyword": "team", "count": 21 }, { "keyword": "call", "count": 12 } ], "subject_length_stats": { "avg_length": 54, "min_length": 22, "max_length": 88 }, "warmup_messages_filtered": 620 } } ``` -------------------------------- ### POST /warmup/subscriptions Source: https://docs.inboxkit.com/list-warmup-subscriptions-28170226e0 List all warmup subscriptions. ```APIDOC ## POST /warmup/subscriptions ### Description Retrieves a list of all warmup subscriptions. ### Method POST ### Endpoint /warmup/subscriptions ``` -------------------------------- ### List Warmup Subscriptions Success Response Source: https://docs.inboxkit.com/list-warmup-subscriptions-28170226e0 Example JSON response returned upon a successful request, containing a list of subscriptions and pagination metadata. ```json { "error": false, "message": "Warmup subscriptions retrieved successfully", "subscriptions": [ { "uid": "ws-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "active", "mailbox_email": "john@example.com", "price_per_month": 3, "health_status": "excellent", "started_at": "2025-01-15T10:30:00.000Z", "next_billing_date": "2025-02-15T10:30:00.000Z", "cached_stats": { "emails_sent": 150, "emails_received": 120, "health_score": 85.5, "inbox_rate": 92.3, "current_volume": 25, "target_volume": 50, "warmup_day": 14 }, "mailbox": { "uid": "mb-123e4567-e89b-12d3-a456-426614174000", "username": "john", "domain_name": "example.com", "first_name": "John", "last_name": "Doe", "platform": "GOOGLE", "status": "active" }, "createdAt": "2025-01-15T10:30:00.000Z" } ], "total": 25, "pages": 3, "current_page": 1, "limit": 10 } ``` -------------------------------- ### Get Mailbox Subject Analysis Request Source: https://docs.inboxkit.com/get-mailbox-subject-analysis-30003626e0 Example cURL request to retrieve subject analysis for a mailbox. Requires the Authorization bearer token and X-Workspace-Id header. ```bash curl --location 'https://api.inboxkit.com/v1/api/email-insights/mailbox/12b5275a-0fb5-44c8-8b9f-f07368950f0e/subject-analysis?period=30&limit=20&direction=sent' \ --header 'X-Workspace-Id: c145ecc0-6487-49c5-bbbe-46748495cfd2' \ --header 'Authorization: Bearer ' ``` -------------------------------- ### Get DNS records cURL request Source: https://docs.inboxkit.com/get-dns-records-18118381e0 Example cURL command to retrieve DNS records. Requires the X-Workspace-Id header and a Bearer token in the Authorization header. ```bash curl --location 'https://api.inboxkit.com/v1/api/dns/list?domain=undefined&uid=undefined' \ --header 'X-Workspace-Id;' \ --header 'Authorization: Bearer ' ``` -------------------------------- ### WebhookPayload JSON Example Source: https://docs.inboxkit.com/webhookpayload-9399674d0 A sample JSON structure for a WebhookPayload, demonstrating a domain.status_changed event with associated domain and metadata objects. ```json { "event": "domain.status_changed", "timestamp": "2019-08-24T14:15:22.123Z", "team_id": "string", "team_name": "string", "data": { "domain": { "uid": "string", "name": "string", "tld": "string", "status": "pending", "previous_status": "string", "dns_propagation_status": "pending", "nameservers": [ "string" ], "connection_type": "dns", "assigned_mailboxes": 0, "available_mailboxes": 0, "tags": [ "string" ], "renewal_date": "2019-08-24T14:15:22.123Z", "renewal_status": "not_due" }, "metadata": { "property1": "string", "property2": "string" } } } ``` -------------------------------- ### Get resetup status cURL request Source: https://docs.inboxkit.com/get-resetup-status-35638474e0 Example cURL command to fetch the resetup status for a domain. Replace the placeholders with your actual domain identifier and workspace ID. ```shell curl --location 'https://api.inboxkit.com/v1/api/mailboxes/resetup-status?domain_uid=&domain_name=' \ --header 'X-Workspace-Id;' \ --header 'Authorization: Bearer ' ``` -------------------------------- ### Subscription details response example Source: https://docs.inboxkit.com/get-subscription-details-18118392e0 This JSON object represents the structure of the successful response, containing team details, current subscription status, and available pricing plans. ```json { "team": "Acme Corp", "email": "admin@acme.com", "current_subscription": { "_id": "string", "uid": "string", "name": "Professional", "cycle": "monthly", "pricing": 29.99, "features": [ "string" ] }, "purchased_on": "2023-01-15T10:30:00.000Z", "renews_on": "2023-02-15T10:30:00.000Z", "pricing_plans": [ {} ] } ``` -------------------------------- ### Get Mailbox Details Request Source: https://docs.inboxkit.com/get-mailbox-details-18118370e0 Example cURL command to retrieve mailbox details. Replace with your actual bearer token and provide the required workspace ID. ```shell curl --location 'https://api.inboxkit.com/v1/api/mailboxes/details?uid=undefined' \ --header 'X-Workspace-Id;' \ --header 'Authorization: Bearer ' ``` -------------------------------- ### Register Domains Request Source: https://docs.inboxkit.com/register-domains-18118349e0 A cURL command demonstrating how to register domains with contact details and configuration settings. ```bash curl --location 'https://api.inboxkit.com/v1/api/domains/register' \ --header 'X-Workspace-Id;' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data-raw '{ "domains": [ { "name": "example.com", "registration_years": 2 } ], "domain_forwarding_url": "https://example.com", "dmarc_email": "admin@example.com", "enable_mask_forwarding": false, "catch_all_email": "catchall@example.com", "use_wallet_balance": false, "contact_details": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone": "+1234567890", "organization": "Acme Corp", "address_line1": "123 Main St", "address_line2": "Suite 100", "city": "New York", "state": "NY", "country": "US", "postal_code": "10001" } }' ``` -------------------------------- ### POST /workspaces Source: https://docs.inboxkit.com/ Create a new workspace. ```APIDOC ## POST /workspaces ### Description Create workspace. ### Method POST ### Endpoint /workspaces ``` -------------------------------- ### Get workspace details response example Source: https://docs.inboxkit.com/get-workspace-details-18118363e0 The JSON response body returned upon a successful request, containing workspace metadata such as name, webhook URL, and member information. ```json { "error": false, "message": "Workspace fetched successfully", "workspace": { "uid": "ws_123456789", "name": "Marketing Team", "webhook_url": "https://example.com/webhook", "use_shared_billing": true, "members": [ { "email": "user@example.com", "role": "admin", "full_name": "John Doe", "uid": "string" } ], "domains": 5, "assigned_domains": 3, "assignable_domains": 2, "created_at": "2019-08-24T14:15:22.123Z", "updated_at": "2019-08-24T14:15:22.123Z" } } ``` -------------------------------- ### Get Mailbox Stats Request Source: https://docs.inboxkit.com/get-mailbox-stats-30003617e0 Example cURL request to retrieve mailbox statistics. Requires the mailbox UID in the path, a workspace ID header, and a bearer token for authorization. ```bash curl --location 'https://api.inboxkit.com/v1/api/email-insights/mailbox/12b5275a-0fb5-44c8-8b9f-f07368950f0e/stats?period=30' \ --header 'X-Workspace-Id: c145ecc0-6487-49c5-bbbe-46748495cfd2' \ --header 'Authorization: Bearer ' ```