---
title: "Forward a message"
method: POST
path: "/v1/inboxes/{inbox_id}/forward"
tags: ["sending"]
---

# Forward a message

`POST /v1/inboxes/{inbox_id}/forward`

## Request

- Base URL: `https://cherami.to`
- URL: `https://cherami.to/v1/inboxes/{inbox_id}/forward`
- Auth: HTTP bearer

Forwards `message_id`, a ready received message or an accepted sent message in the sending inbox, to the recipients in `to`, `cc` and `bcc`. Recipients are used exactly as given, with the limits of [send](https://cherami.to/docs/api/sending/send-message). An optional `note` goes above the forwarded message.

The forward carries a header block with the original From, Date, Subject, To and Cc (never Bcc), then the original text and HTML as they are, quoted history included: check them for anything the new recipients shouldn't see. The subject gets `Fwd: ` unless it already starts with `Fw:` or `Fwd:`. A forward starts a new conversation.

The original attachments, embedded images included, are attached unless `include_attachments` is `false`, which leaves out every file, so images in the HTML may not display.

Outcomes are those of [send](https://cherami.to/docs/api/sending/send-message#response-and-outcomes), and retries those of [reply](https://cherami.to/docs/api/sending/reply-message#retry-a-reply-or-forward).

## Path parameters

- `inbox_id` string, required

## Request body

- ForwardInput
  - `message_id` string, required: ID of a ready received message or an accepted sent message in this inbox.
  - `to` Mailbox[], required
    - `address` string, required: Bare address such as alex@example.com: ASCII, at most 254 characters and 64 before the @.
    - `name` string: Optional name; blank means none. At most 256 UTF-8 bytes after trimming, without control characters.
  - `cc` Mailbox[]
    - `address` string, required: Bare address such as alex@example.com: ASCII, at most 254 characters and 64 before the @.
    - `name` string: Optional name; blank means none. At most 256 UTF-8 bytes after trimming, without control characters.
  - `bcc` Mailbox[]
    - `address` string, required: Bare address such as alex@example.com: ASCII, at most 254 characters and 64 before the @.
    - `name` string: Optional name; blank means none. At most 256 UTF-8 bytes after trimming, without control characters.
  - `note` string: Optional plain-text introduction above the forwarded message.
  - `include_attachments` boolean: false leaves out every original file, embedded images included.
  - `labels` Label[]: Label names, case-sensitive; order and duplicates don't matter.
  - `idempotency_key` string: Your unique value for this one operation. Save it with the exact request before sending; repeating that request with the same key within 24 hours returns what the first one did instead of acting again.

## Response `200`

A retry matched an earlier request: this is that request's result as it is now. Nothing new was created or sent.

- object: accepted in message.status means the provider took the message, not that it was delivered.
  - `limited` unknown, required
  - `message` SentMetadata, required
    - `id` string, required: Cherami resource ID.
    - `inbox_id` string, required: Cherami resource ID.
    - `created_at` string, date-time, required: UTC timestamp with milliseconds.
    - `recipient_count` integer, required
    - `status` 'accepted' | 'rejected' | 'unknown', required
    - `provider_message_id` string, nullable, required: Message-ID the provider assigned when it accepted the message.
    - `error_code` string, nullable, required: Reason code for a rejected or unknown outcome, such as E_RECIPIENT_SUPPRESSED or acceptance_unknown.
    - `thread_id` string, nullable, required: Cherami resource ID.
    - `in_reply_to` string, nullable, required: Cherami resource ID.
    - `labels` string[], required
  - `outcome_persisted` boolean, required: false: this response is the only record of the outcome; keep it rather than resending.
  - `replayed` true, required: true when a retry matched an earlier request: the result is that request's, and nothing new was created or sent.
  - `idempotency_expires_at` string, date-time, required: When the key stops protecting retries.

## Other responses

- `201`: Attempt recorded; check message.status.
- `400`: `invalid_json`: Send a valid UTF-8 JSON object, not an array or scalar. `invalid_message`: Correct the recipients, subject, body, `in_reply_to`, attachments or reply and forward fields as the message describes. `invalid_name`: Use plain text without control characters, at most 256 UTF-8 bytes after trimming. The message names the field. `invalid_labels`: Correct the label name, label change, filter group or discovery prefix the message names. `invalid_idempotency_key`: Use 1–128 ASCII letters, digits, hyphens or underscores.
- `401`: `unauthorized`: Send a valid API key as `Authorization: Bearer <key>`. If the key stopped working, get a new one through [recovery](https://cherami.to/docs/guides/recovery).
- `403`: `operation_not_allowed`: Sending, or deletion and restore, is turned off for this account; the message says which. Contact hello@cherami.to. `recipient_not_allowed`: Nothing was sent: the inbox's [sending rules](https://cherami.to/account/sending-rules) block one or more recipients, which the message lists. Use allowed recipients, or ask the account owner to allow them; do not send through another inbox to get around the rules.
- `404`: `not_found`: The resource does not exist or does not belong to this account. A reply or forward source must also be in the sending inbox.
- `409`: `reply_not_ready`: The source cannot be replied to or forwarded yet. A received message must have `processing_status` `ready`; a sent message must have `status` `accepted`. `idempotency_conflict`: The key was first used with different input. To recover that request, repeat it with its original inbox and payload; a different request needs its own key. `idempotency_result_unavailable`: The key already created an inbox, draft or send whose result has since been deleted. Nothing new was created or sent; do not repeat the request under a new key. If a sent message is still in Trash, restore it to read the outcome.
- `413`: `body_too_large`: Reduce the JSON request to the operation's body limit. `message_too_large`: The message exceeds 5 MiB counting text, HTML and base64 attachment content, or a forwarded original has more than 32 attachments. Reduce the content or attachments; for a forward, set `include_attachments` to false or attach selected files to a new message.
- `415`: `unsupported_media_type`: Send `Content-Type: application/json`.
- `429`: `outbound_limit_reached`: The rolling 24-hour sending allowance cannot cover this message, at one charge per recipient. With `reason` `temporary_exhaustion`, retry at `sufficient_capacity_at`; with `message_exceeds_allowance`, the message needs more than the whole allowance: reduce its recipients or [request a higher allowance](https://cherami.to/docs/guides/support). See [sending allowance](https://cherami.to/docs/api/sending/get-outbound-quota).
- `503`: `content_unavailable`: Stored content could not be read. Retry later. `outbound_unavailable`: The request failed. If it was a send, reply or forward, its outcome is unknown: repeat it with the same idempotency key and unchanged payload within 24 hours of the first request; without a key, check sent messages before sending again. Retry a read.

---

[API](https://skmtc.dev/cherami/apis/cherami-http-api.md) · [All operations](https://skmtc.dev/cherami/apis/cherami-http-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cherami/apis/cherami-http-api/revisions/7bd993d538af?raw)
