Skip to main content
PATCH
Update a sending account

Authorizations

Authorization
string
header
required

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

Path Parameters

channel
enum<string>
required

email for a mailbox, linkedin for a LinkedIn seat.

Available options:
email,
linkedin
accountId
string
required

The account's id from GET /v1/accounts: a mailbox's address (any case, @ as is or as %40) or a seat's id.

Required string length: 1 - 320

Body

application/json
name
string

Mailboxes: the sender name recipients see. A seat's name is its LinkedIn profile's.

Maximum string length: 200
dailyCapacity
integer

Mailboxes: the most emails it sends a day, 1 to 15. Start a mailbox under 3 months old at 5.

Required range: 1 <= x <= 15
dailyLimits
object

Seats: invitations and messages a day, together. Free seats allow up to 20 and 80, premium seats up to 80 and 150.

weeklyLimits
object

Seats: invitations and messages a week, together. Free seats allow up to 100 and 400, premium seats up to 200 and 800.

signature
string

What {Sender Signature} inserts: HTML on a mailbox, up to 10,000 characters; plain text on a seat, up to 2,000. Empty removes it.

Maximum string length: 10000

Response

The account.

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.