Skip to main content
POST
Connect a mailbox

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Headers

Idempotency-Key
string

Names this operation, so a retry with the same key and body gets the first success again, marked Idempotent-Replayed, instead of running or charging twice. A mailbox's password is not compared: the same mailbox sent again with another password is the same call, and gets the first answer. Kept 24 hours for your organization and this route. A refusal (4xx) frees the key at once, so a corrected retry runs. After a server error (5xx), which may still take effect, the key stays held for 5 minutes from the call's start, and a retry in that time answers 409 idempotency_in_progress; after that, a send or import that may already have gone out answers 409 idempotency_outcome_unknown instead of running again. 1 to 255 visible ASCII characters, such as a UUID.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]+$

Body

application/json
emailAddress
string
required

The mailbox's address. It becomes the account's id, in lower case.

Maximum string length: 320
smtpHost
string
required

The outgoing (SMTP) server, such as smtp.fernway.co.

imapHost
string
required

The incoming (IMAP) server, such as imap.fernway.co.

password
string
required

The mailbox's password, or an app password where the provider asks for one. Checked by signing in, kept encrypted, never shown.

Required string length: 1 - 1024
name
string

The sender name, for a new mailbox.

Maximum string length: 200
smtpPort
number

465 (the default) for TLS, or 587 for STARTTLS.

smtpSecure
boolean

True (the default) for TLS on port 465, false for STARTTLS on 587.

imapPort
number

993 (the default).

imapSecure
boolean

True (the default) for TLS.

authUser
string

The sign-in name, when it is not emailAddress.

Maximum string length: 320

Response

The mailbox, connected.

A mailbox (channel email) or a LinkedIn seat (channel linkedin). A field without a value is absent.

channel
enum<string>
required
Available options:
email,
linkedin
id
string
required

A mailbox's email address, or a seat's id.

isActive
boolean
required

Campaigns may send from it.

isConnected
boolean
required

Its sign-in works.

name
string

A mailbox's sender name, or the seat's LinkedIn profile name.

emailAddress
string

Mailboxes.

provider
string

Mailboxes: smtp, gmail or outlook.

dailyCapacity
integer

Mailboxes: the most emails it sends a day.

availableCapacity
integer

Mailboxes: what is left of it today.

needsReauthAt
string<date-time>

Mailboxes: when its sign-in stopped working.

needsReauthReason
string

Mailboxes: why, such as smtp_auth_rejected.

warmup
object

Mailboxes: its warmup.

email
string

Seats: the LinkedIn sign-in email.

publicIdentifier
string

Seats: the profile's address name, as in linkedin.com/in/...

type
string

Seats: classic, sales_navigator or recruiter.

status
string

Seats, one at a time: connected, reconnected or disconnected.

dailyLimits
object

Seats, one at a time: invitations and messages a day.

dailyRemaining
object

Seats, one at a time: what is left today.

weeklyLimits
object

Seats, one at a time: invitations and messages a week.

weeklyRemaining
object

Seats, one at a time: what is left this week (from Monday, UTC).

signature
string

One at a time: the signature {Sender Signature} inserts.