InboxMark a whole conversation read / unread

Mark a whole conversation read / unread

curl -X PATCH "https://api.supasend.io/v1/inbox/threads/507f1f77bcf86cd799439011" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "is_read": true
}'
{
  "id": "example_string",
  "mailbox_id": "example_string",
  "root_message_id": "example_string",
  "subject": "example_string",
  "participants": [
    "example_string"
  ],
  "email_job_id": "user@example.com",
  "message_count": 25,
  "unread_count": 10,
  "last_message_at": "2024-12-25T10:00:00Z",
  "last_message_direction": "inbound",
  "last_inbound_at": "2024-12-25T10:00:00Z",
  "snippet": "example_string",
  "created_at": "2024-12-25T10:00:00Z",
  "updated_at": "2024-12-25T10:00:00Z"
}
PATCH
/v1/inbox/threads/{id}
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-API-Key)
X-API-Keystring
Required

API key in the format sk_live_<64 hex characters>

API key in the format sk_live_<64 hex characters>
path
idstring
Required

MongoDB ObjectID

Content-Typestring
Required

The media type of the request body

Options: application/json
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. API key in the format sk_live_\<64 hex characters\>

Path Parameters

idstring
Required

MongoDB ObjectID

Example:
507f1f77bcf86cd799439011

Body

application/json

Responses

idstring
mailbox_idstring
root_message_idstring
subjectstring
participantsstring[]

Counterparty addresses (your mailbox is excluded)

email_job_idstring

The send that started the conversation, when it was yours

message_countinteger
unread_countinteger
last_message_atstring
last_message_directionstring
Allowed values:inboundoutbound
last_inbound_atstring
snippetstring
created_atstring
updated_atstring