integrations

post/api/integrations/instantly/mailboxes

Request

  • Base URL: https://app.heykairon.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.heykairon.com/api/integrations/instantly/mailboxes
  • Auth: API key in header x-api-key

Request body

emailstring email required

The full address of a mailbox the customer already owns, like ada@acme.com.

firstNamestring required

The mailbox owner's first name — it appears in the From line of every send.

lastNamestring required

The mailbox owner's last name.

provider'google' | 'microsoft' | 'custom' required

Who hosts the mailbox. google for Google Workspace or Gmail, microsoft for Microsoft 365 or Outlook — both fill in their own server settings. custom for anything else, and then all four host and port fields are required.

passwordstring required

An APP PASSWORD for the mailbox, not the account password. For Google the operator creates one in their Google account with 2-step verification on. Ask them for it directly and never invent one; it is passed straight to the sending provider and stored nowhere in Kairon.

smtpHoststring

Outgoing mail server, custom provider only (Google and Microsoft are known).

smtpPortinteger

Outgoing mail port, custom provider only — usually 465 or 587.

imapHoststring

Incoming mail server, custom provider only.

imapPortinteger

Incoming mail port, custom provider only — usually 993.

Changes

No recorded changes to this operation across all 6 revisions of this API.