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.

Corpo da requisição

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.

Payload de resposta

string

obrigatório

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

obrigatório

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

channel

string

obrigatório

Channel this message was carried on. Always email.

thread_id

string

obrigatório

Conversation this message belongs to.

from

string

obrigatório

Sender address.

array of string

obrigatório

Recipient addresses on the To line.

array of string

obrigatório

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

delivered_to

nullable string

obrigatório

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

obrigatório

Message subject. Null when the message had no subject.

preview

nullable string

obrigatório

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

obrigatório

Whether the message has been marked read. Null for sent messages.

disposition

nullable string

obrigatório

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

obrigatório

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

obrigatório

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

obrigatório

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

obrigatório

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

obrigatório

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

obrigatório

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

obrigatório

Number of attachments on the message.

attachment_manifest

array of object

obrigatório

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

Mostrar atributos secundários

attachment_manifest.id

string

obrigatório

Attachment ID, used to download the attachment bytes.

attachment_manifest.filename

nullable string

obrigatório

Original filename, or null when the attachment had none.

attachment_manifest.content_type

nullable string

obrigatório

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

attachment_manifest.size

integer

obrigatório

Attachment size in bytes.

reference_ids

array of string

obrigatório

RFC 5322 References header entries used to thread the conversation.

labels

array of string

obrigatório

Labels applied to this message. A message carries at most 20 labels.

contact_id

nullable string

obrigatório

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

source

object

obrigatório

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.

Mostrar atributos secundários

source.resource

string

obrigatório

API path of the log entry for this message.

source.available_until

string

obrigatório

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

occurred_at

string

obrigatório

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."
  }'