Skip to main content
PATCH
Update a conversation

Authorizations

Authorization
string
header
required

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

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
isRead
boolean

Marks every message read, or with false unread (email only: a LinkedIn chat can only be marked read).

isFavorite
boolean

Email only. Stars the conversation, or with false takes the star off.

isArchived
boolean

Email only. Moves it to Archived, or with false back to the inbox.

isSpam
boolean

Email only. Moves it to Spam, or with false back to the inbox.

isDeleted
boolean

Email only. Moves it to Trash, or with false back to the inbox.

label
enum<string>

Email only: interested or not_interested on the newest email received, or null to take both off.

Available options:
interested,
not_interested,
null

Response

The conversation and the changes made.

id
string
required
channel
string
required
isRead
boolean
isFavorite
boolean
isArchived
boolean
isSpam
boolean
isDeleted
boolean
label
enum<string> | null

Null when the labels were taken off.

Available options:
interested,
not_interested,
null