Skip to main content
POST
Send a message

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
channel
enum<string>
required

email or linkedin.

Available options:
email,
linkedin
content
string
required

The message. Email: HTML, up to 100,000 characters (wrap paragraphs in <p>). LinkedIn: plain text, up to 8,000 characters.

Maximum string length: 100000
Pattern: \S
from
string

Email only, and needed: the mailbox to send from, as GET /v1/accounts?channel=email lists it.

Maximum string length: 320
to
string[]

Email only, and needed: 1 to 50 recipients.

Required array length: 1 - 50 elements
Maximum string length: 320
cc
string[]

Email only: up to 50 addresses to copy.

Maximum array length: 50
Maximum string length: 320
bcc
string[]

Email only: up to 50 addresses to blind-copy.

Maximum array length: 50
Maximum string length: 320
subject
string

Email: needed, up to 998 characters. LinkedIn: an InMail's subject, up to 200 characters, only with inMail.

Maximum string length: 998
Pattern: \S
scheduledAt
string<date-time>

Email only: when to send it, as an ISO 8601 date-time. Now when left out.

accountId
string

LinkedIn only, and needed: the seat to send from, by its id.

Required string length: 1 - 100
linkedinUrl
string

LinkedIn only, and needed: the profile of the person to write to.

Maximum string length: 500
Pattern: ^(https?:\/\/)?([\w-]+\.)?linkedin\.com\/in\/[^\s/?#]+
inMail
boolean

LinkedIn only: true sends an InMail, which reaches someone the seat is not connected to and spends one of the seat's InMail credits. It needs a Premium, Sales Navigator or Recruiter seat.

Response

The message, sent, or scheduled.

channel
enum<string>
required
Available options:
email,
linkedin
status
enum<string>
required
Available options:
sent,
scheduled
conversationId
string

The conversation it is in, when known.

messageId
string

Email: the message's id, once sent.