Get Draft

GET

/v0/pods/:pod_id/drafts/:draft_id

GET

/v0/pods/:pod_id/drafts/:draft_id

1 from agentmail import AgentMail
2 
3 client = AgentMail(
4     api_key="YOUR_TOKEN_HERE",
5 )
6 
7 client.pods.drafts.get(
8     pod_id="pod_id",
9     draft_id="draft_id",
10 )

1 {
2   "inbox_id": "inbox_id",
3   "draft_id": "draft_id",
4   "labels": [
5     "labels",
6     "labels"
7   ],
8   "updated_at": "2024-01-15T09:30:00Z",
9   "created_at": "2024-01-15T09:30:00Z",
10   "client_id": "client_id",
11   "reply_to": [
12     "reply_to",
13     "reply_to"
14   ],
15   "to": [
16     "to",
17     "to"
18   ],
19   "cc": [
20     "cc",
21     "cc"
22   ],
23   "bcc": [
24     "bcc",
25     "bcc"
26   ],
27   "subject": "subject",
28   "preview": "preview",
29   "text": "text",
30   "html": "html",
31   "attachments": [
32     {
33       "attachment_id": "attachment_id",
34       "size": 1,
35       "filename": "filename",
36       "content_type": "content_type",
37       "content_disposition": "inline",
38       "content_id": "content_id"
39     },
40     {
41       "attachment_id": "attachment_id",
42       "size": 1,
43       "filename": "filename",
44       "content_type": "content_type",
45       "content_disposition": "inline",
46       "content_id": "content_id"
47     }
48   ],
49   "in_reply_to": "in_reply_to",
50   "references": [
51     "references",
52     "references"
53   ],
54   "send_status": "scheduled",
55   "send_at": "2024-01-15T09:30:00Z"
56 }

**CLI:** ```bash agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id> ```

Get Draft

GET

/v0/pods/:pod_id/drafts/:draft_id

GET

/v0/pods/:pod_id/drafts/:draft_id

1 from agentmail import AgentMail
2 
3 client = AgentMail(
4     api_key="YOUR_TOKEN_HERE",
5 )
6 
7 client.pods.drafts.get(
8     pod_id="pod_id",
9     draft_id="draft_id",
10 )

1 {
2   "inbox_id": "inbox_id",
3   "draft_id": "draft_id",
4   "labels": [
5     "labels",
6     "labels"
7   ],
8   "updated_at": "2024-01-15T09:30:00Z",
9   "created_at": "2024-01-15T09:30:00Z",
10   "client_id": "client_id",
11   "reply_to": [
12     "reply_to",
13     "reply_to"
14   ],
15   "to": [
16     "to",
17     "to"
18   ],
19   "cc": [
20     "cc",
21     "cc"
22   ],
23   "bcc": [
24     "bcc",
25     "bcc"
26   ],
27   "subject": "subject",
28   "preview": "preview",
29   "text": "text",
30   "html": "html",
31   "attachments": [
32     {
33       "attachment_id": "attachment_id",
34       "size": 1,
35       "filename": "filename",
36       "content_type": "content_type",
37       "content_disposition": "inline",
38       "content_id": "content_id"
39     },
40     {
41       "attachment_id": "attachment_id",
42       "size": 1,
43       "filename": "filename",
44       "content_type": "content_type",
45       "content_disposition": "inline",
46       "content_id": "content_id"
47     }
48   ],
49   "in_reply_to": "in_reply_to",
50   "references": [
51     "references",
52     "references"
53   ],
54   "send_status": "scheduled",
55   "send_at": "2024-01-15T09:30:00Z"
56 }

CLI:

$ agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id>

**CLI:** ```bash agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id> ```

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

1	from agentmail import AgentMail
2
3	client = AgentMail(
4	api_key="YOUR_TOKEN_HERE",
5	)
6
7	client.pods.drafts.get(
8	pod_id="pod_id",
9	draft_id="draft_id",
10	)

1	{
2	"inbox_id": "inbox_id",
3	"draft_id": "draft_id",
4	"labels": [
5	"labels",
6	"labels"
7	],
8	"updated_at": "2024-01-15T09:30:00Z",
9	"created_at": "2024-01-15T09:30:00Z",
10	"client_id": "client_id",
11	"reply_to": [
12	"reply_to",
13	"reply_to"
14	],
15	"to": [
16	"to",
17	"to"
18	],
19	"cc": [
20	"cc",
21	"cc"
22	],
23	"bcc": [
24	"bcc",
25	"bcc"
26	],
27	"subject": "subject",
28	"preview": "preview",
29	"text": "text",
30	"html": "html",
31	"attachments": [
32	{
33	"attachment_id": "attachment_id",
34	"size": 1,
35	"filename": "filename",
36	"content_type": "content_type",
37	"content_disposition": "inline",
38	"content_id": "content_id"
39	},
40	{
41	"attachment_id": "attachment_id",
42	"size": 1,
43	"filename": "filename",
44	"content_type": "content_type",
45	"content_disposition": "inline",
46	"content_id": "content_id"
47	}
48	],
49	"in_reply_to": "in_reply_to",
50	"references": [
51	"references",
52	"references"
53	],
54	"send_status": "scheduled",
55	"send_at": "2024-01-15T09:30:00Z"
56	}