1. Connect Inbox
  • Litemail Docs
  • Users
    • Retrieve User Details
      GET
  • Workspaces
    • Retrieve All Workspaces
      GET
    • Create New Workspace
      POST
    • Update Workspace
      PUT
  • Billings
    • Add Billing Details
      POST
  • Mailboxes
    • Retrieve Mailboxes
      GET
    • Assign New Mailbox to Domain
      POST
    • Get Mailbox Details
      GET
    • Update Mailbox
      PUT
    • Remove Mailbox (Next Renewal)
      DELETE
  • Payment & Wallet
    • Get Wallet Balance
      GET
    • Add Balance to Wallet
      POST
    • Enable Auto Recharge
      POST
  • Exports
    • Export Mailboxes
      POST
    • Add Third Party Account Details
      POST
    • Update Third Party Account Details
      PUT
  • Subscriptions
    • Get All Subscriptions
      GET
    • Cancel Subscription
      DELETE
    • Upgrade Subscription
      PUT
  • Domains
    • Retrieve Domains
      GET
    • List Assignable Domains
      GET
    • Add DMARC Records
      POST
    • Add Domain Forwarding
      POST
    • Remove Domain Forwarding
      DELETE
    • Get Name Servers
      GET
    • Verify Name Server Propagation
      GET
    • Connect Domains with Zapmail
      POST
    • Enable Email Forwarding
      POST
    • Remove Email Forwarding
      DELETE
    • Enable Catch-All Emails
      POST
    • Remove Catch-All Emails
      DELETE
    • Check DNS Records
      GET
    • Remove Unused Domain
      DELETE
    • Get Available Domains for Registration
      GET
    • Get Domain Purchase Payment Link
      GET
  • DNS
    • Get DNS Records
    • Add DNS Record
    • Update DNS Record
    • Delete DNS Record
  • apikeys testing
    • generate key by login first
  • Connect Inbox
    • connect-inboxes
      POST
  1. Connect Inbox

connect-inboxes

Developing
POST
/v1/connect-inbox

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Body Params application/jsonRequired

Example
{
  "platform_type": "instantly",
  "platform_email": "support@litemail.ai",
  "platform_pass": "Lite@Mail2024!",
  "inbox_type": "gmail",
  "inboxes": [
    {
      "email": "caroline@getbrandmerge.com",
      "pass": "Caroline@Thompson2025"
    }
  ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/connect-inbox' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "platform_type": "instantly",
  "platform_email": "support@litemail.ai",
  "platform_pass": "Lite@Mail2024!",
  "inbox_type": "gmail",
  "inboxes": [
    {
      "email": "caroline@getbrandmerge.com",
      "pass": "Caroline@Thompson2025"
    }
  ]
}'

Responses

🟢200Success
application/json
Body

Example
{"error":"Unauthorized","message":"Authentication required. Provide x-api-key header or valid JWT token.","path":"/v1/connectinbox","timestamp":"2026-01-29T18:41:56.867Z"}
Previous
generate key by login first
Built with