Reply to a thread message

POST

/v1/email/threads/{thread_id}/messages/{message_id}/reply

curl -X POST "https://us1.platform.bird.com/v1/email/threads/{thread_id}/messages/{message_id}/reply" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Thanks — confirming we received your request."
  }'

Sends a reply to a specific message in a conversation, from the mailbox's own address. Recipients are derived from the message being replied to — its Reply-To address when present, otherwise its From address; set reply_all to also include the original To and Cc recipients. The subject and the threading headers that keep the reply in this conversation are set automatically, and the reply is recorded in the conversation. To reply to a conversation as a whole, target its newest received message.

Treść żądania

html

string

HTML body of the reply. At least one of html or text must be provided.

text

string

Plain-text body of the reply. At least one of html or text must be provided.

reply_all

boolean

Also send the reply to the original To and Cc recipients, minus the mailbox's own address.

category

string

Content classification — controls suppression policy. marketing blocks on all suppression reasons; transactional allows delivery through complaint and unsubscribe suppressions. Default: transactional.

Possible values: marketing, transactional

attachments

array of object

File attachments to include with the reply. The send is rejected when the estimated generated message size exceeds 20 MB (bodies plus all attachments after base64 encoding). Keep total raw attachment content at or below 15 MB for reliable headroom. Attachment metadata endures on the message's attachment_manifest; the bytes are downloadable for 30 days.

Pokaż parametry podrzędne

attachments.filename

string

wymagane

Filename shown to the recipient. Required.

attachments.content

string

wymagane

Base64-encoded attachment bytes. Required. Counts toward the 20 MB estimated generated message-size cap after encoding and MIME wrapping.

attachments.path

string

Preview feature — provide a URL and Bird fetches the attachment for you. Currently unavailable. Use content instead. The schema currently requires content, so a request with only path is rejected with 422 for missing content; a request supplying both content and path is rejected with 422 UnsupportedEmailFeature until this preview ships. When generally available: HTTPS-only, single redirect followed and re-validated, private IP ranges blocked, request timeout enforced, fetched content counts toward the 20 MB estimated generated message-size cap after encoding and MIME wrapping.

attachments.content_type

string

MIME type. Inferred from filename extension when omitted. Used to enforce the blocklist of disallowed executable / script types.

attachments.content_id

string

RFC 2392 Content-ID. When set, the attachment is rendered inline and can be referenced from the HTML body as <img src="cid:{content_id}"/>. When omitted, the attachment is rendered as a regular file attachment.

Treść odpowiedzi

string

wymagane

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

wymagane

Direction of the message — inbound for a received message, outbound for a sent one.

Possible values: inbound, outbound

channel

string

wymagane

Channel this message was carried on. Always email.

thread_id

string

wymagane

Conversation this message belongs to.

from

string

wymagane

Sender address.

array of string

wymagane

Recipient addresses on the To line.

array of string

wymagane

Recipient addresses on the Cc line. Empty when the message had none.

delivered_to

nullable string

wymagane

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

wymagane

Message subject. Null when the message had no subject.

preview

nullable string

wymagane

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.

labels

array of string

wymagane

Labels on this message. System labels carry its state: a received message holds exactly one placement label — inbox for accepted mail, archive when its conversation was filed away, spam (failed sender authentication), or blocked (rejected by the mailbox's receive policy or rules) — plus unread until it is read. trash marks a message in the trash, either direction. Custom labels share the same list; a message carries at most 20.

status

nullable string

wymagane

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

wymagane

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.

authentication

nullable string

wymagane

Whether the sender of a received message was authenticated. pass means the sender's identity was verified; fail means it was checked and did not verify; unknown means no verdict could be determined and the sender should not be treated as verified. Null for sent messages. 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.

Possible values: pass, fail, unknown, null

spf_pass

nullable boolean

wymagane

Whether SPF passed for the sender of a received message. Null for sent messages and when no verdict is available. Durable for the mailbox's retention period.

dkim_pass

nullable boolean

wymagane

Whether DKIM passed for the sender of a received message. Null for sent messages and when no verdict is available. Durable for the mailbox's retention period.

dmarc_pass

nullable boolean

wymagane

Whether DMARC passed for the sender of a received message. Null for sent messages and when no verdict is available. Durable for the mailbox's retention period.

purge_at

string

wymagane

When the message will be permanently deleted: the end of the mailbox's retention period, pulled nearer (at most 30 days out) while the message is in the trash. Restore a trashed message before then with PATCH {"labels": {"remove": ["trash"]}}.

attachment_count

integer

wymagane

Number of attachments on the message.

attachment_manifest

array of object

wymagane

Attachment metadata (filename, content type, size). Remains readable for the mailbox's retention period even after the attachment bytes themselves have expired.

Pokaż atrybuty podrzędne

attachment_manifest.id

string

wymagane

Attachment ID, used to download the attachment bytes.

attachment_manifest.filename

nullable string

wymagane

Original filename, or null when the attachment had none.

attachment_manifest.content_type

nullable string

wymagane

MIME content type, or null when it could not be determined.

attachment_manifest.size

integer

wymagane

Attachment size in bytes.

reference_ids

array of string

wymagane

RFC 5322 References header entries used to thread the conversation.

contact_id

nullable string

wymagane

Contact linked to this message, or null when none is linked.

source

object

wymagane

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.

Pokaż atrybuty podrzędne

source.resource

string

wymagane

API path of the log entry for this message.

source.available_until

string

wymagane

When the log entry (and the message's original rendered source) expires.

occurred_at

string

wymagane

When the message was received or accepted for sending.

curl -X POST "https://us1.platform.bird.com/v1/email/threads/{thread_id}/messages/{message_id}/reply" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Thanks — confirming we received your request."
  }'