Skip to main content
PATCH
Update conversations in bulk

Authorizations

Authorization
string
header
required

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

Body

application/json
conversationIds
string[]
required

1 to 50 email conversations, each once, by id.

Required array length: 1 - 50 elements
Required string length: 1 - 2048
isRead
boolean

Marks every message read, or with false unread.

isFavorite
boolean

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

isArchived
boolean

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

isSpam
boolean

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

isDeleted
boolean

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

Response

What happened to each conversation, in the order sent.

results
object[]
required