Get Draft | AgentMail | Documentation

from agentmail import AgentMail
client = AgentMail(
    api_key="YOUR_TOKEN_HERE",
)
client.pods.drafts.get(
    pod_id="pod_id",
    draft_id="draft_id",
)

{
  "inbox_id": "inbox_id",
  "draft_id": "draft_id",
  "labels": [
    "labels",
    "labels"
  ],
  "updated_at": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-15T09:30:00Z",
  "client_id": "client_id",
  "reply_to": [
    "reply_to",
    "reply_to"
  ],
  "to": [
    "to",
    "to"
  ],
  "cc": [
    "cc",
    "cc"
  ],
  "bcc": [
    "bcc",
    "bcc"
  ],
  "subject": "subject",
  "preview": "preview",
  "text": "text",
  "html": "html",
  "attachments": [
    {
      "attachment_id": "attachment_id",
      "size": 1,
      "filename": "filename",
      "content_type": "content_type",
      "content_disposition": "inline",
      "content_id": "content_id"
    },
    {
      "attachment_id": "attachment_id",
      "size": 1,
      "filename": "filename",
      "content_type": "content_type",
      "content_disposition": "inline",
      "content_id": "content_id"
    }
  ],
  "in_reply_to": "in_reply_to",
  "references": [
    "references",
    "references"
  ],
  "send_status": "scheduled",
  "send_at": "2024-01-15T09:30:00Z"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

pod_idstringRequired

ID of pod.

draft_idstringRequired

ID of draft.

Response

This endpoint returns an object.

inbox_idstring

The ID of the inbox.

draft_idstring

ID of draft.

labelslist of strings

Labels of draft.

updated_atdatetime

Time at which draft was last updated.

created_atdatetime

Time at which draft was created.

client_idstring

Client ID of draft.

reply_tolist of strings

Reply-to addresses. In format username@domain.com or Display Name <username@domain.com>.

tolist of strings

Addresses of recipients. In format username@domain.com or Display Name <username@domain.com>.

cclist of strings

Addresses of CC recipients. In format username@domain.com or Display Name <username@domain.com>.

bcclist of strings

Addresses of BCC recipients. In format username@domain.com or Display Name <username@domain.com>.

subjectstring

Subject of draft.

previewstring

Text preview of draft.

textstring

Plain text body of draft.

htmlstring

HTML body of draft.

attachmentslist of objects

Attachments in draft.

in_reply_tostring

ID of message being replied to.

referenceslist of strings

IDs of previous messages in thread.

send_statusenum

Schedule send status of draft.

Allowed values:

send_atdatetime

Time at which to schedule send draft.

Errors

404

Not Found Error