Skip to main content
import { createClient } from "@mailsai/sdk";

const client = createClient(); // reads MAILS_API_KEY

const result = await client.drafts.create({
  agent: "hello",
  to: "jordan@example.com",
  subject: "Following up on order #10473",
  body_text: "Just confirming your order arrived.",
});
console.log(result);
{
  "id": "dft_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "agent_id": "agt_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "to": ["jordan@example.com"],
  "cc": ["jordan@example.com"],
  "bcc": ["jordan@example.com"],
  "subject": "<subject>",
  "body_text": "<body_text>",
  "body_html": "<body_html>",
  "reply_to": "jordan@example.com",
  "in_reply_to_message_id": "msg_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "reply_kind": "reply",
  "thread_id": "thrd_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "tags": [{ "name": "<name>", "value": "<value>" }],
  "send_at": "2026-10-04T12:00:00.000Z",
  "list_unsubscribe": false,
  "status": "draft",
  "sent_message_id": "msg_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "error_message": "<error_message>",
  "created_at": "2026-10-04T12:00:00.000Z",
  "updated_at": "2026-10-04T12:00:00.000Z"
}

Create a draft

Creates a draft, or a scheduled draft if send_at is in the future.
import { createClient } from "@mailsai/sdk";

const client = createClient(); // reads MAILS_API_KEY

const result = await client.drafts.create({
  agent: "hello",
  to: "jordan@example.com",
  subject: "Following up on order #10473",
  body_text: "Just confirming your order arrived.",
});
console.log(result);
{
  "id": "dft_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "agent_id": "agt_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "to": ["jordan@example.com"],
  "cc": ["jordan@example.com"],
  "bcc": ["jordan@example.com"],
  "subject": "<subject>",
  "body_text": "<body_text>",
  "body_html": "<body_html>",
  "reply_to": "jordan@example.com",
  "in_reply_to_message_id": "msg_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "reply_kind": "reply",
  "thread_id": "thrd_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "tags": [{ "name": "<name>", "value": "<value>" }],
  "send_at": "2026-10-04T12:00:00.000Z",
  "list_unsubscribe": false,
  "status": "draft",
  "sent_message_id": "msg_01JZX8K3M9Q4P7VN2YB6RTDC0E",
  "error_message": "<error_message>",
  "created_at": "2026-10-04T12:00:00.000Z",
  "updated_at": "2026-10-04T12:00:00.000Z"
}

Body Parameters

agentstring

Which agent sends the draft: its name or agt_ id. Left out: the agent a key is tied to, else the workspace's only agent, or a new one named agent when there is none and the key may create agents (the manage scope; otherwise 403 insufficient_scope). With several agents and a key tied to none, it is required (400 missing_field).

tostring | string[]

Who the draft goes to: one address, or a list of up to 50. It is stored and returned as a list. A draft can be saved without one, but it needs one to be sent or scheduled (400 missing_field). With reply_kind and left out, it is worked out from the email.

ccstring[]

Addresses to copy when the draft is sent, up to 50.

bccstring[]

Addresses to blind-copy when the draft is sent, up to 50. They appear in none of the email's headers.

subjectstring

Subject line, 1 to 998 characters. A draft without one is sent with an empty subject.

body_textstring

Plain-text body, up to 1,000,000 characters. A draft can be saved without a body.

body_htmlstring

HTML body, up to 1,000,000 characters. A draft can be saved without a body.

reply_tostring

The address replies to the sent draft should go to. Left out, replies go to the agent's receiving_address.

in_reply_to_message_idstring

Id of the message this one answers (msg_… or rcv_…), named in the email's In-Reply-To header. Once sent, the draft joins its thread when the same agent sent or received it. Left out, it starts a new thread. An id this workspace does not hold, or a message this key cannot read, is refused (404 resource_not_found).

send_atstring

Schedule the draft to send at this time: an ISO 8601 UTC time ending in Z, in the future (400 invalid_field otherwise). It needs the send scope. Left out, the draft waits until it is sent.

tagsobject[]

Up to 10 name-value labels, copied onto the message when the draft is sent; they are not part of the email.

Show propertiesHide properties
namestringrequired

Tag name: 1 to 256 letters, digits, _ or -.

valuestringrequired

Tag value, up to 256 characters; it may be empty.

list_unsubscribeboolean

Opt in to RFC 8058 one-click unsubscribe: the message carries List-Unsubscribe and List-Unsubscribe-Post: List-Unsubscribe=One-Click headers, so the recipient's mail app shows an Unsubscribe button. One click suppresses the address for your whole workspace: every later send to it from any of your agents is refused with recipient_suppressed until you allowlist it (POST /v1/suppression/allow). Turn it on for newsletters, digests and other recurring mail. Leave it off (the default) for password resets, sign-in links, receipts and anything else the recipient must keep receiving.

Needs exactly one to recipient and no cc or bcc.

reply_kindstring

Make this the reply to, or the forward of, the email named by in_reply_to_message_id, which is then required. It needs the read scope too. An email has at most one unsent reply and one unsent forward: a second request answers 200 with the first, unchanged. The agent is the email's, and to, cc and subject default as POST /v1/messages/{id}/reply and /forward set them; a forward's body_text defaults to the quoted email, and its files come along.

One of: reply, forward

reply_allboolean

With reply_kind: "reply": also copy everyone else on the email, as reply_all does on POST /v1/messages/{id}/reply.

Headers

Idempotency-Keystring

Replays the stored response for a repeated key (kept 24 hours), so a retried request never double-sends; the replay carries Idempotent-Replay: true. An error is kept on the key only once the mail has gone out, so a replayed error means it was sent. Once a scheduled send is stored, a failure after that keeps the message's answer on the key instead: the retry answers with the message (201) and raises its message.scheduled if the first request did not. After a failure before either, the same key sends again, as it does after a batch that stored no message and sent no mail. An Idempotency-Key used again with a different body, or on a different route, is refused with invalid_idempotency_key. Only credentials of the same mode, bound to the same agent or to none, share a key: for any other, the same key is a new request.

Scheduling sends the draft at that time, so a send_at needs the send scope: a key with only draft gets 403 insufficient_scope. A draft can be saved without to, and needs one to be sent or scheduled. With reply_kind it answers the email in in_reply_to_message_id: an email has at most one unsent reply and one unsent forward, and a second request answers 200 with the first, unchanged. Idempotency-Key is honoured. Files are not part of this request (422 invalid_field, param attachments): add each with POST /v1/drafts/{id}/attachments.

Response

idstring

Draft id (dft_…).

agent_idstring

Id (agt_…) of the agent the draft is sent from, chosen when it was created.

tostring[]

The draft's recipients, always as a list, even when one address was given.

ccstring[]

The draft's Cc addresses. Absent when cc was never given; [] when it was given empty or a PATCH emptied it.

bccstring[]

The draft's Bcc addresses, who receive it but appear in none of its headers. Absent when bcc was never given; [] when it was given empty or a PATCH emptied it.

subjectstring

The draft's subject. Absent when none was given; the draft is then sent with an empty subject.

body_textstring

The draft's plain-text body. Absent when none was given.

body_htmlstring

The draft's HTML body. Absent when none was given.

reply_tostring

The address replies should go to, as given on create; absent when none was.

in_reply_to_message_idstring

Id of the message this draft answers (msg_… or rcv_…), as given on create; absent when none was.

reply_kindstring

Set on a draft made as the reply to, or the forward of, the email in in_reply_to_message_id. An email has at most one of each unsent. Absent on any other draft.

One of: reply, forward

thread_idstring

The thread the draft's message joined (thrd_…), written when the draft is sent: the thread of the message named by sent_message_id, also when the send could not be fully recorded after that message was stored (see error_message). Absent until it is sent, when a send could not be recorded far enough to store its message (no sent_message_id), once that thread is deleted, and on drafts sent before this field was filled in.

tagsobject[]

Name-value labels saved with the draft and copied onto the message when it is sent. Absent when none were given.

Show propertiesHide properties
namestring

The tag's name, as given on the send, reply or draft.

valuestring

The tag's value, as given; it may be an empty string.

send_atstring

The time the draft is scheduled for (UTC); it stays after the draft is sent. Absent when it was never scheduled or was unscheduled with send_at: null.

list_unsubscribeboolean

Whether the draft is sent with RFC 8058 one-click unsubscribe headers (list_unsubscribe on create or update; off by default). One click suppresses the recipient for the whole workspace.

statusstring

draft: saved, not scheduled. scheduled: waiting for send_at. sending: being sent now. sent: see sent_message_id. failed: the send failed, see error_message. canceled: a scheduled reply whose conversation was deleted before it went out. Only draft and scheduled drafts can be edited or sent.

One of: draft, scheduled, sending, sent, failed, canceled

sent_message_idstring

Id (msg_…) of the message the draft became when it was sent. Absent on a draft not yet sent; a sent draft whose send could not be fully recorded (see error_message) can lack it too.

error_messagestring

Why the draft is failed or canceled. On a sent draft it reports a send that went out but could not be fully recorded. Absent otherwise.

created_atstring

When the draft was created (UTC).

updated_atstring

When the draft last changed: an edit, a new schedule, or a status change as it is sent.

Was this page helpful?