Forward a message

POSThttps://anjal.app/v1/inboxes/{id}/forward/{messageId}

Prepends a "Forwarded message" header block and sends the combined body.

Path parameters

`id` required string	Inbox UUID
`messageId` required string	Message UUID

Header parameters

Idempotency-Key

string

Unique value for this send (e.g. a UUID). A retry with the same key and identical request returns the stored response (header `Idempotent-Replayed: true`) and sends nothing. Same key with a different request: 409 `IDEMPOTENCY_KEY_REUSED`. Same key while the first is still running: 409 `IDEMPOTENCY_IN_PROGRESS`. Blank: 400 `IDEMPOTENCY_KEY_INVALID`. Keys are per account and expire after 24 hours; a failed send (non-2xx) frees the key.

Request body

Content-Type: application/json

`to` required string \| string[]
`subject` string
`plainBody` string
`htmlBody` string
`labels` string[] \| string	Labels as an array or a comma-separated string. Stored lowercase and deduplicated; at most 32 labels of at most 64 characters, no commas.
`trackOpens` boolean	Add an open-tracking pixel (HTML body only). See `SendExtras`. default: false

Responses

200Sent

400Validation error, or IDEMPOTENCY_KEY_INVALID

409application/json`IDEMPOTENCY_KEY_REUSED` (the key was used for a different request) or `IDEMPOTENCY_IN_PROGRESS` (the first request with this key is still running).

`error` required string
`code` string

Authentication

Send your API key in the X-API-Key header (or Authorization: Bearer <key>). Any prefix accepted by this endpoint — tk_, wk_, ak_, or sa_ — is documented in the key prefix table.

Request

import { Anjal } from "anjal";

const client = new Anjal({ apiKey: process.env.MYAGENTMAIL_API_KEY! });

// POST /v1/inboxes/{id}/forward/{messageId}
const result = await client.request("post", "/v1/inboxes/{id}/forward/{messageId}", { params: { id: "00000000-0000-0000-0000-000000000000", messageId: "00000000-0000-0000-0000-000000000000" } }, { body: {
  "subject": "string",
  "plainBody": "string",
  "htmlBody": "string",
  "labels": [
    "needs-review",
    "q4-campaign"
  ],
  "trackOpens": false
} });