logo
InboxForward a conversation

Forward a conversation

Forwards a conversation to one or more recipients as a new email thread.

The server assembles the forwarded chain (Gmail-style ---------- Forwarded message --------- header followed by the full thread), re-attaches any prior Gmail reply attachments, and sends from the chosen mailbox.

  • The first address in toEmails becomes the To; the rest are prepended to cc.
  • body and plainText are both optional — if omitted, only the forwarded chain is sent. If only one of the two is provided, the server derives the other.
  • fromMailboxId overrides the sending mailbox; otherwise the conversation's last-used mailbox is chosen, then any active campaign mailbox as a fallback.
  • Attachments must have been uploaded via POST /v1/inbox/attachments/upload (their key must live under inbox-attachments/<workspaceId>/).

Asynchronous: returns 202 Accepted with a jobId. Poll the sending-worker status endpoint (GET /api/jobs/{jobId} on the workspace's worker host) to observe progress. The job is enqueued onto the workspace's node Redis.

curl -X POST "https://api.sendkit.ai/v1/inbox/example_string/forward" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
  "toEmails": [
    "colleague@example.com"
  ],
  "body": "<p>FYI — forwarding this thread.</p>"
}'
{
  "success": true,
  "data": {
    "jobId": "forward_email_1748352000123_a1b2c3d",
    "status": "pending",
    "message": "Forward queued. Poll worker /api/jobs/:jobId for status."
  }
}
POST
/v1/inbox/{conversationId}/forward
POST
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
path
conversationIdstring
Required

Conversation ID (the inbox thread ID)

Content-Typestring
Required

The media type of the request body

Options: application/json
toEmailsarray
Required

Recipients. First entry becomes To; the rest are prepended to CC.

bodystring

HTML body of the user's forwarding note. Optional.

plainTextstring

Plain-text body of the user's forwarding note. Optional.

fromMailboxIdstring

Mailbox to send from. Must be active and belong to this workspace.

attachmentsarray

Attachments from POST /v1/inbox/attachments/upload.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

Path Parameters

conversationIdstring
Required

Conversation ID (the inbox thread ID)

Body

application/json
toEmailsarray
Required

Recipients. First entry becomes To; the rest are prepended to CC.

bodystring

HTML body of the user's forwarding note. Optional.

plainTextstring

Plain-text body of the user's forwarding note. Optional.

fromMailboxIdstring

Mailbox to send from. Must be active and belong to this workspace.

attachmentsarray

Attachments from POST /v1/inbox/attachments/upload.

Responses