Skip to content

Mark Whatsapp Conversation Read

POST
/inbox/whatsapp/conversations/{chat_id}/read

Mark a WhatsApp chat read or unread (read: false). read: true marks it read ON WHATSAPP: the prospect may see read receipts.

Authorizations

Parameters

Path Parameters

chat_id
required

WhatsApp chat id.

string

WhatsApp chat id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mark a conversation read or unread.

object
account_id
Any of:
string
read
boolean
default: true

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string