Update a message in a thread
PATCH
/v1/email/threads/{thread_id}/messages/{message_id}
curl -X PATCH "https://us1.platform.bird.com/v1/email/threads/{thread_id}/messages/{message_id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'Applies read-state, label, and contact changes to a message in a conversation. Omitted fields are left unchanged. The read flag is only valid on received messages.
请求载荷
read
boolean
Mark the message read (true) or unread (false). Only valid on received messages.
labels
object
Label changes to apply. Labels in add are applied and labels in remove are taken off; other labels are left untouched. Adding a label that is already present, or removing one that is not, has no effect.
显示子参数
labels.add
array of string
Labels to apply.
labels.remove
array of string
Labels to take off.
contact_id
nullable string
Contact to link this message to, or null to unlink the current contact.
trashed
boolean
Set to false to restore a trashed message within its 30-day trash window (clears trashed_at and restores the original retention). To trash a message use DELETE; true is rejected.
响应载荷
id
string
必填
Message ID. Received messages carry a rem_ ID, sent messages an em_ ID — the same IDs used by the received-message and sent-message logs.
direction
string
必填
Direction of the message — inbound for a received message, outbound for a sent one.
channel
string
必填
Channel this message was carried on. Always email.
thread_id
string
必填
Conversation this message belongs to.
from
string
必填
Sender address.
to
array of string
必填
Recipient addresses on the To line.
cc
array of string
必填
Recipient addresses on the Cc line. Empty when the message had none.
delivered_to
nullable string
必填
Address the message was actually delivered to, when it differs from the mailbox address (for example mail routed in from another address). Null for sent messages and for mail addressed directly to the mailbox.
subject
nullable string
必填
Message subject. Null when the message had no subject.
preview
nullable string
必填
Short plain-text preview of the message body.
extracted_text
nullable string
Plain-text content of the message with quoted history stripped — readable for the mailbox's full retention period, both directions. Always present when fetching a single message; on list endpoints it is included only when the request sets include=extracted_text. Null when no text could be extracted.
read
nullable boolean
必填
Whether the message has been marked read. Null for sent messages.
disposition
nullable string
必填
Where the message landed: inbox for accepted mail, blocked (receive policy or rules), or unauthenticated (failed sender authentication). Null for sent messages. Trash state is carried separately in trashed_at.
status
nullable string
必填
Folded delivery status of a sent message: accepted, sent (provider handoff), delivered (all attempted recipients delivered), or failed (terminal failure). Null for received messages.
recipients
nullable array
必填
Terminal per-recipient delivery outcomes of a sent message, folded in as they become known — part of the message's durable memory. Null for received messages and before any recipient reaches a terminal state. Per-recipient event detail lives on the sent-message log (source) for 30 days.
spf_pass
nullable boolean
必填
Whether SPF passed for the sender of a received message. Null for sent messages and when no verdict was computable. Part of the message's durable memory — readable for the mailbox's full retention period, so the verdict survives after the 30-day inbound log has expired.
dkim_pass
nullable boolean
必填
Whether DKIM passed for the sender of a received message. Null for sent messages and when no verdict was computable. Durable for the mailbox's retention period.
dmarc_pass
nullable boolean
必填
Whether DMARC passed for the sender of a received message. Null for sent messages and when no verdict was computable. Durable for the mailbox's retention period.
trashed_at
nullable string
必填
When the message was moved to the trash, or null when it is not trashed. Trashed messages are purged 30 days after trashing; restore it with PATCH {"trashed": false} before then.
rank
number
Relevance rank of this result. Present only on search results, higher is more relevant.
attachment_count
integer
必填
Number of attachments on the message.
attachment_manifest
array of object
必填
Attachment metadata (filename, content type, size). Remains readable for the mailbox's retention period even after the attachment bytes themselves have expired.
显示子属性
attachment_manifest.id
string
必填
Attachment ID, used to download the attachment bytes.
attachment_manifest.filename
nullable string
必填
Original filename, or null when the attachment had none.
attachment_manifest.content_type
nullable string
必填
MIME content type, or null when it could not be determined.
attachment_manifest.size
integer
必填
Attachment size in bytes.
reference_ids
array of string
必填
RFC 5322 References header entries used to thread the conversation.
labels
array of string
必填
Labels applied to this message. A message carries at most 20 labels.
contact_id
nullable string
必填
Contact linked to this message, or null when none is linked.
source
object
必填
Link to the message's entry in the received-message or sent-message log, which carries delivery analytics such as per-recipient events. Log entries expire 30 days after the message occurred.
显示子属性
source.resource
string
必填
API path of the log entry for this message.
source.available_until
string
必填
When the log entry (and the message's original rendered source) expires.
occurred_at
string
必填
When the message was received or accepted for sending.