Forward a thread message

POST

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

curl -X POST "https://us1.platform.bird.com/v1/email/threads/{thread_id}/messages/{message_id}/forward" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": [
      "ops@example.com"
    ]
  }'

Forwards a message in a conversation to new recipients, from the mailbox's own address. The original body and attachments are sent as they were received or sent, the subject gains a Fwd: prefix, and the forward is recorded in the conversation. Forwarding requires the message's original rendered source, which is available for 30 days after the message occurred; after that this endpoint returns an error.

Treść żądania

array of string

wymagane

Recipient addresses to forward the message to.

array of string

Cc recipient addresses.

category

string

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

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.

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.

read

nullable boolean

wymagane

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

disposition

nullable string

wymagane

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

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.

spf_pass

nullable boolean

wymagane

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

wymagane

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

wymagane

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

wymagane

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

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.

labels

array of string

wymagane

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

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}/forward" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": [
      "ops@example.com"
    ]
  }'