Skip to main content
POST
Reply in a conversation

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]+$

Path Parameters

conversationId
string
required

The conversation's id, from GET /v1/conversations.

Required string length: 1 - 2048

Body

application/json
channel
enum<string>
required

email or linkedin.

Available options:
email,
linkedin
content
string
required

The reply. 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
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
inReplyToMessageId
string

Email only: the messageId of the message to answer. The newest when left out.

Required string length: 1 - 1000

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.