AgentMail

AgentMail integration (Communication, Productivity). Imported from open-connector.

API key102 toolshttps://api.agentmail.to

POST

agent_mail_create_inbox

Create a new AgentMail inbox.

/v0/inboxes

5 parameters

Param	Type	Required	Description
username	string	optional	Inbox username. AgentMail generates one when omitted.
domain	string	optional	Verified domain used by the inbox. Defaults to agentmail.to.
display_name	string	optional	Display name shown for the inbox.
client_id	string	optional	Client-side identifier associated with the inbox.
metadata	object	optional	Custom metadata attached to the inbox.

GET

agent_mail_list_inboxes

List inboxes available to the current AgentMail API key.

/v0/inboxes

3 parameters

Param	Type	Required	Description
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.

GET

agent_mail_get_inbox

Get a single AgentMail inbox.

/v0/inboxes/{inbox_id}

1 parameter

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.

PATCH

agent_mail_update_inbox

Update an AgentMail inbox display name or metadata.

/v0/inboxes/{inbox_id}

3 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
display_name	string	optional	Display name shown for the inbox.
metadata	object	optional	—

DELETE

agent_mail_delete_inbox

Delete an AgentMail inbox.

/v0/inboxes/{inbox_id}

1 parameter

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.

GET

agent_mail_list_inbox_threads

List threads in a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/threads

14 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
labels	array	optional	Labels used to filter or apply to a record.
before	string	optional	Only include records before this ISO 8601 timestamp.
after	string	optional	Only include records after this ISO 8601 timestamp.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.
include_spam	boolean	optional	Whether spam threads should be included in the result.
include_blocked	boolean	optional	Whether blocked threads should be included in the result.
include_unauthenticated	boolean	optional	Whether unauthenticated threads should be included in the result.
include_trash	boolean	optional	Whether trash threads should be included in the result.
senders	array	optional	Sender addresses used to filter threads.
recipients	array	optional	Recipient addresses used to filter threads.
subject	array	optional	Subject filters used by AgentMail.

GET

agent_mail_search_inbox_threads

Search threads in a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/threads/search

6 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
q	string	required	Search query.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
before	string	optional	Only include records before this ISO 8601 timestamp.
after	string	optional	Only include records after this ISO 8601 timestamp.

GET

agent_mail_get_inbox_thread

Get a single thread from a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/threads/{thread_id}

2 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
thread_id	string	required	The AgentMail thread identifier.

PATCH

agent_mail_update_inbox_thread

Update labels on a thread in a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/threads/{thread_id}

4 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
thread_id	string	required	The AgentMail thread identifier.
add_labels	array	optional	Labels used to filter or apply to a record.
remove_labels	array	optional	Labels used to filter or apply to a record.

DELETE

agent_mail_delete_inbox_thread

Delete a thread from a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/threads/{thread_id}

3 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
thread_id	string	required	The AgentMail thread identifier.
permanent	boolean	optional	Whether the thread should be permanently deleted.

GET

agent_mail_get_inbox_thread_attachment

Get metadata and download URL for an attachment in an AgentMail inbox thread.

/v0/inboxes/{inbox_id}/threads/{thread_id}/attachments/{attachment_id}

3 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
thread_id	string	required	The AgentMail thread identifier.
attachment_id	string	required	The AgentMail attachment identifier.

GET

agent_mail_list_messages

List messages from a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/messages

14 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
labels	array	optional	Labels used to filter or apply to a record.
before	string	optional	Only include records before this ISO 8601 timestamp.
after	string	optional	Only include records after this ISO 8601 timestamp.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.
include_spam	boolean	optional	Whether spam messages should be included in the result.
include_blocked	boolean	optional	Whether blocked messages should be included in the result.
include_unauthenticated	boolean	optional	Whether unauthenticated messages should be included in the result.
include_trash	boolean	optional	Whether trash messages should be included in the result.
from	string	optional	Sender address used to filter messages.
to	string	optional	Recipient address used to filter messages.
subject	array	optional	Subject filters used by AgentMail.

GET

agent_mail_search_messages

Search messages in a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/messages/search

6 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
q	string	required	Search query.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
before	string	optional	Only include records before this ISO 8601 timestamp.
after	string	optional	Only include records after this ISO 8601 timestamp.

GET

agent_mail_get_message

Get a single message from a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/messages/{message_id}

2 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
message_id	string	required	The AgentMail message identifier.

PATCH

agent_mail_update_message

Update labels on a message in a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/messages/{message_id}

4 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
message_id	string	required	The AgentMail message identifier.
add_labels	array	optional	Labels used to filter or apply to a record.
remove_labels	array	optional	Labels used to filter or apply to a record.

POST

agent_mail_batch_get_messages

Fetch multiple messages from a specific AgentMail inbox by message ID.

/v0/inboxes/{inbox_id}/messages/batch-get

2 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
message_ids	array	optional	Message IDs to fetch.

GET

agent_mail_get_message_attachment

Get metadata and download URL for an attachment on a specific AgentMail message.

/v0/inboxes/{inbox_id}/messages/{message_id}/attachments/{attachment_id}

3 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
message_id	string	required	The AgentMail message identifier.
attachment_id	string	required	The AgentMail attachment identifier.

GET

agent_mail_get_raw_message

Get a presigned download URL for the raw EML version of an AgentMail message.

/v0/inboxes/{inbox_id}/messages/{message_id}/raw

2 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
message_id	string	required	The AgentMail message identifier.

POST

agent_mail_send_message

Send a message from a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/messages/send

11 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
labels	array	optional	Labels used to filter or apply to a record.
reply_to	string	optional	Email address or email address list.
to	string	optional	Email address or email address list.
cc	string	optional	Email address or email address list.
bcc	string	optional	Email address or email address list.
subject	string	optional	Subject line of the message.
text	string	optional	Plain text body of the message.
html	string	optional	HTML body of the message.
attachments	array	optional	Attachments to include in the message.
headers	object	optional	Custom message headers to include in the outbound message.

POST

agent_mail_reply_to_message

Reply to a specific AgentMail message.

/v0/inboxes/{inbox_id}/messages/{message_id}/reply

12 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
message_id	string	required	The AgentMail message identifier.
labels	array	optional	Labels used to filter or apply to a record.
reply_to	string	optional	Email address or email address list.
to	string	optional	Email address or email address list.
cc	string	optional	Email address or email address list.
bcc	string	optional	Email address or email address list.
reply_all	boolean	optional	Whether to reply to all recipients of the original message.
text	string	optional	Plain text body of the reply.
html	string	optional	HTML body of the reply.
attachments	array	optional	Attachments to include in the reply.
headers	object	optional	Custom message headers to include in the outbound message.

POST

agent_mail_reply_all_message

Reply to all recipients of a specific AgentMail message.

/v0/inboxes/{inbox_id}/messages/{message_id}/reply-all

8 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
message_id	string	required	The AgentMail message identifier.
labels	array	optional	Labels used to filter or apply to a record.
reply_to	string	optional	Email address or email address list.
text	string	optional	Plain text body of the reply.
html	string	optional	HTML body of the reply.
attachments	array	optional	Attachments to include in the reply.
headers	object	optional	Custom message headers to include in the outbound message.

POST

agent_mail_forward_message

Forward a specific AgentMail message.

/v0/inboxes/{inbox_id}/messages/{message_id}/forward

12 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
message_id	string	required	The AgentMail message identifier.
labels	array	optional	Labels used to filter or apply to a record.
reply_to	string	optional	Email address or email address list.
to	string	optional	Email address or email address list.
cc	string	optional	Email address or email address list.
bcc	string	optional	Email address or email address list.
subject	string	optional	Subject line of the forwarded message.
text	string	optional	Plain text body of the forwarded message.
html	string	optional	HTML body of the forwarded message.
attachments	array	optional	Attachments to include in the forwarded message.
headers	object	optional	Custom message headers to include in the outbound message.

GET

agent_mail_list_drafts

List drafts from a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/drafts

7 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
labels	array	optional	Labels used to filter or apply to a record.
before	string	optional	Only include records before this ISO 8601 timestamp.
after	string	optional	Only include records after this ISO 8601 timestamp.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.

POST

agent_mail_create_draft

Create a draft in a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/drafts

13 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
labels	array	optional	Labels used to filter or apply to a record.
reply_to	string	optional	Email address or email address list.
to	string	optional	Email address or email address list.
cc	string	optional	Email address or email address list.
bcc	string	optional	Email address or email address list.
subject	string	optional	Subject line of the draft.
text	string	optional	Plain text body of the draft.
html	string	optional	HTML body of the draft.
attachments	array	optional	Attachments to include in the draft.
in_reply_to	string	optional	The AgentMail message identifier.
send_at	string	optional	Time at which AgentMail should schedule the draft to send.
client_id	string	optional	Client-side identifier associated with the draft.

GET

agent_mail_get_draft

Get a draft from a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/drafts/{draft_id}

2 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
draft_id	string	required	The AgentMail draft identifier.

PATCH

agent_mail_update_draft

Update a draft in a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/drafts/{draft_id}

10 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
draft_id	string	required	The AgentMail draft identifier.
reply_to	string	optional	Email address or email address list.
to	string	optional	Email address or email address list.
cc	string	optional	Email address or email address list.
bcc	string	optional	Email address or email address list.
subject	string	optional	Subject line of the draft.
text	string	optional	Plain text body of the draft.
html	string	optional	HTML body of the draft.
send_at	string	optional	Time at which AgentMail should schedule the draft to send.

DELETE

agent_mail_delete_draft

Delete a draft from a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/drafts/{draft_id}

2 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
draft_id	string	required	The AgentMail draft identifier.

GET

agent_mail_get_draft_attachment

Get metadata and download URL for an attachment on a specific AgentMail draft.

/v0/inboxes/{inbox_id}/drafts/{draft_id}/attachments/{attachment_id}

3 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
draft_id	string	required	The AgentMail draft identifier.
attachment_id	string	required	The AgentMail attachment identifier.

POST

agent_mail_send_draft

Send a specific AgentMail draft.

/v0/inboxes/{inbox_id}/drafts/{draft_id}/send

4 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
draft_id	string	required	The AgentMail draft identifier.
add_labels	array	optional	Labels used to filter or apply to a record.
remove_labels	array	optional	Labels used to filter or apply to a record.

GET

agent_mail_list_inbox_list_entries

List allow or block entries scoped to a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/lists/{direction}/{type}

5 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.

POST

agent_mail_create_inbox_list_entry

Create an allow or block list entry scoped to a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/lists/{direction}/{type}

5 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
entry	string	required	The email address or domain list entry.
reason	string	optional	Reason for adding the list entry.

GET

agent_mail_get_inbox_list_entry

Get an allow or block list entry scoped to a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}

4 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
entry	string	required	The email address or domain list entry.

DELETE

agent_mail_delete_inbox_list_entry

Delete an allow or block list entry scoped to a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}

4 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
entry	string	required	The email address or domain list entry.

GET

agent_mail_query_inbox_metrics

Query AgentMail metrics scoped to a specific inbox.

/v0/inboxes/{inbox_id}/metrics

7 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
event_types	array	optional	Metric event types to query.
start	string	optional	Start timestamp for the metrics query.
end	string	optional	End timestamp for the metrics query.
period	integer	optional	Period in seconds for each metrics bucket.
limit	integer	optional	Maximum number of items to return.
descending	boolean	optional	Whether metrics should be sorted in descending timestamp order.

GET

agent_mail_list_inbox_events

List events scoped to a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/events

4 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.

GET

agent_mail_list_inbox_api_keys

List API keys scoped to a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/api-keys

3 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.

POST

agent_mail_create_inbox_api_key

Create an API key scoped to a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/api-keys

3 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
name	string	optional	Name of the API key.
permissions	object	optional	Granular AgentMail API key permissions.

DELETE

agent_mail_delete_inbox_api_key

Delete an API key scoped to a specific AgentMail inbox.

/v0/inboxes/{inbox_id}/api-keys/{api_key_id}

2 parameters

Param	Type	Required	Description
inbox_id	string	required	The AgentMail inbox identifier.
api_key_id	string	required	The AgentMail API key identifier.

GET

agent_mail_list_threads

List AgentMail threads across accessible inboxes.

/v0/threads

13 parameters

Param	Type	Required	Description
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
labels	array	optional	Labels used to filter or apply to a record.
before	string	optional	Only include records before this ISO 8601 timestamp.
after	string	optional	Only include records after this ISO 8601 timestamp.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.
include_spam	boolean	optional	Whether spam threads should be included in the result.
include_blocked	boolean	optional	Whether blocked threads should be included in the result.
include_unauthenticated	boolean	optional	Whether unauthenticated threads should be included in the result.
include_trash	boolean	optional	Whether trash threads should be included in the result.
senders	array	optional	Sender addresses used to filter threads.
recipients	array	optional	Recipient addresses used to filter threads.
subject	array	optional	Subject filters used by AgentMail.

GET

agent_mail_search_threads

Search AgentMail threads across accessible inboxes.

/v0/threads/search

5 parameters

Param	Type	Required	Description
q	string	required	Search query.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
before	string	optional	Only include records before this ISO 8601 timestamp.
after	string	optional	Only include records after this ISO 8601 timestamp.

GET

agent_mail_get_thread

Get a single AgentMail thread.

/v0/threads/{thread_id}

1 parameter

Param	Type	Required	Description
thread_id	string	required	The AgentMail thread identifier.

PATCH

agent_mail_update_thread

Update labels on an AgentMail thread.

/v0/threads/{thread_id}

3 parameters

Param	Type	Required	Description
thread_id	string	required	The AgentMail thread identifier.
add_labels	array	optional	Labels used to filter or apply to a record.
remove_labels	array	optional	Labels used to filter or apply to a record.

DELETE

agent_mail_delete_thread

Delete an AgentMail thread.

/v0/threads/{thread_id}

2 parameters

Param	Type	Required	Description
thread_id	string	required	The AgentMail thread identifier.
permanent	boolean	optional	Whether the thread should be permanently deleted.

GET

agent_mail_get_thread_attachment

Get metadata and download URL for an attachment in an AgentMail thread.

/v0/threads/{thread_id}/attachments/{attachment_id}

2 parameters

Param	Type	Required	Description
thread_id	string	required	The AgentMail thread identifier.
attachment_id	string	required	The AgentMail attachment identifier.

GET

agent_mail_list_global_drafts

List AgentMail drafts across accessible inboxes.

/v0/drafts

6 parameters

Param	Type	Required	Description
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
labels	array	optional	Labels used to filter or apply to a record.
before	string	optional	Only include records before this ISO 8601 timestamp.
after	string	optional	Only include records after this ISO 8601 timestamp.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.

GET

agent_mail_get_global_draft

Get a single AgentMail draft across accessible inboxes.

/v0/drafts/{draft_id}

1 parameter

Param	Type	Required	Description
draft_id	string	required	The AgentMail draft identifier.

GET

agent_mail_get_global_draft_attachment

Get metadata and download URL for an attachment on an AgentMail draft.

/v0/drafts/{draft_id}/attachments/{attachment_id}

2 parameters

Param	Type	Required	Description
draft_id	string	required	The AgentMail draft identifier.
attachment_id	string	required	The AgentMail attachment identifier.

GET

agent_mail_list_webhooks

List AgentMail webhooks.

/v0/webhooks

3 parameters

Param	Type	Required	Description
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.

POST

agent_mail_create_webhook

Create an AgentMail webhook.

/v0/webhooks

5 parameters

Param	Type	Required	Description
url	string	required	Webhook endpoint URL.
event_types	array	required	Event types this webhook should receive.
pod_ids	array	optional	Pod IDs subscribed to the webhook.
inbox_ids	array	optional	Inbox IDs subscribed to the webhook.
client_id	string	optional	Client-side identifier associated with the webhook.

GET

agent_mail_get_webhook

Get a single AgentMail webhook.

/v0/webhooks/{webhook_id}

1 parameter

Param	Type	Required	Description
webhook_id	string	required	The AgentMail webhook identifier.

PATCH

agent_mail_update_webhook

Update an AgentMail webhook.

/v0/webhooks/{webhook_id}

6 parameters

Param	Type	Required	Description
webhook_id	string	required	The AgentMail webhook identifier.
add_inbox_ids	array	optional	Inbox IDs to subscribe to the webhook.
remove_inbox_ids	array	optional	Inbox IDs to unsubscribe from the webhook.
add_pod_ids	array	optional	Pod IDs to subscribe to the webhook.
remove_pod_ids	array	optional	Pod IDs to unsubscribe from the webhook.
event_types	array	optional	Full replacement list of event types for the webhook.

DELETE

agent_mail_delete_webhook

Delete an AgentMail webhook.

/v0/webhooks/{webhook_id}

1 parameter

Param	Type	Required	Description
webhook_id	string	required	The AgentMail webhook identifier.

GET

agent_mail_list_domains

List AgentMail domains.

/v0/domains

3 parameters

Param	Type	Required	Description
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.

POST

agent_mail_create_domain

Create an AgentMail domain.

/v0/domains

2 parameters

Param	Type	Required	Description
domain	string	optional	Domain name to add to AgentMail.
feedback_enabled	boolean	optional	Whether bounce and complaint notifications are sent to inboxes.

GET

agent_mail_get_domain

Get a single AgentMail domain.

/v0/domains/{domain_id}

1 parameter

Param	Type	Required	Description
domain_id	string	required	The AgentMail domain identifier.

PATCH

agent_mail_update_domain

Update an AgentMail domain.

/v0/domains/{domain_id}

2 parameters

Param	Type	Required	Description
domain_id	string	required	The AgentMail domain identifier.
feedback_enabled	boolean	optional	Whether bounce and complaint notifications are sent to inboxes.

DELETE

agent_mail_delete_domain

Delete an AgentMail domain.

/v0/domains/{domain_id}

1 parameter

Param	Type	Required	Description
domain_id	string	required	The AgentMail domain identifier.

GET

agent_mail_get_domain_zone_file

Get the DNS zone file records needed for an AgentMail domain.

/v0/domains/{domain_id}/zone-file

1 parameter

Param	Type	Required	Description
domain_id	string	required	The AgentMail domain identifier.

POST

agent_mail_verify_domain

Ask AgentMail to verify a domain's DNS records.

/v0/domains/{domain_id}/verify

1 parameter

Param	Type	Required	Description
domain_id	string	required	The AgentMail domain identifier.

GET

agent_mail_list_list_entries

List global AgentMail allow or block entries.

/v0/lists/{direction}/{type}

4 parameters

Param	Type	Required	Description
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.

POST

agent_mail_create_list_entry

Create a global AgentMail allow or block list entry.

/v0/lists/{direction}/{type}

4 parameters

Param	Type	Required	Description
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
entry	string	required	The email address or domain list entry.
reason	string	optional	Reason for adding the list entry.

GET

agent_mail_get_list_entry

Get a global AgentMail allow or block list entry.

/v0/lists/{direction}/{type}/{entry}

3 parameters

Param	Type	Required	Description
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
entry	string	required	The email address or domain list entry.

DELETE

agent_mail_delete_list_entry

Delete a global AgentMail allow or block list entry.

/v0/lists/{direction}/{type}/{entry}

3 parameters

Param	Type	Required	Description
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
entry	string	required	The email address or domain list entry.

GET

agent_mail_query_metrics

Query AgentMail metrics across accessible resources.

/v0/metrics

6 parameters

Param	Type	Required	Description
event_types	array	optional	Metric event types to query.
start	string	optional	Start timestamp for the metrics query.
end	string	optional	End timestamp for the metrics query.
period	integer	optional	Period in seconds for each metrics bucket.
limit	integer	optional	Maximum number of items to return.
descending	boolean	optional	Whether metrics should be sorted in descending timestamp order.

GET

agent_mail_list_api_keys

List AgentMail API keys.

/v0/api-keys

3 parameters

Param	Type	Required	Description
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.

POST

agent_mail_create_api_key

Create an AgentMail API key.

/v0/api-keys

2 parameters

Param	Type	Required	Description
name	string	optional	Name of the API key.
permissions	object	optional	Granular AgentMail API key permissions.

DELETE

agent_mail_delete_api_key

Delete an AgentMail API key.

/v0/api-keys/{api_key_id}

1 parameter

Param	Type	Required	Description
api_key_id	string	required	The AgentMail API key identifier.

GET

agent_mail_list_pods

List AgentMail pods.

/v0/pods

3 parameters

Param	Type	Required	Description
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.

POST

agent_mail_create_pod

Create an AgentMail pod.

/v0/pods

2 parameters

Param	Type	Required	Description
name	string	optional	Name of the pod.
client_id	string	optional	Client-side identifier associated with the pod.

GET

agent_mail_get_pod

Get a single AgentMail pod.

/v0/pods/{pod_id}

1 parameter

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.

DELETE

agent_mail_delete_pod

Delete an AgentMail pod.

/v0/pods/{pod_id}

1 parameter

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.

GET

agent_mail_list_pod_inboxes

List AgentMail inboxes scoped to a pod.

/v0/pods/{pod_id}/inboxes

4 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.

POST

agent_mail_create_pod_inbox

Create an AgentMail inbox scoped to a pod.

/v0/pods/{pod_id}/inboxes

6 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
username	string	optional	Inbox username. AgentMail generates one when omitted.
domain	string	optional	Verified domain used by the inbox. Defaults to agentmail.to.
display_name	string	optional	Display name shown for the inbox.
client_id	string	optional	Client-side identifier associated with the inbox.
metadata	object	optional	Custom metadata attached to the inbox.

GET

agent_mail_get_pod_inbox

Get a single AgentMail inbox scoped to a pod.

/v0/pods/{pod_id}/inboxes/{inbox_id}

2 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
inbox_id	string	required	The AgentMail inbox identifier.

PATCH

agent_mail_update_pod_inbox

Update an AgentMail inbox scoped to a pod.

/v0/pods/{pod_id}/inboxes/{inbox_id}

4 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
inbox_id	string	required	The AgentMail inbox identifier.
display_name	string	optional	Display name shown for the inbox.
metadata	object	optional	—

DELETE

agent_mail_delete_pod_inbox

Delete an AgentMail inbox scoped to a pod.

/v0/pods/{pod_id}/inboxes/{inbox_id}

2 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
inbox_id	string	required	The AgentMail inbox identifier.

GET

agent_mail_list_pod_threads

List AgentMail threads scoped to a pod.

/v0/pods/{pod_id}/threads

14 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
labels	array	optional	Labels used to filter or apply to a record.
before	string	optional	Only include records before this ISO 8601 timestamp.
after	string	optional	Only include records after this ISO 8601 timestamp.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.
include_spam	boolean	optional	Whether spam threads should be included in the result.
include_blocked	boolean	optional	Whether blocked threads should be included in the result.
include_unauthenticated	boolean	optional	Whether unauthenticated threads should be included in the result.
include_trash	boolean	optional	Whether trash threads should be included in the result.
senders	array	optional	Sender addresses used to filter threads.
recipients	array	optional	Recipient addresses used to filter threads.
subject	array	optional	Subject filters used by AgentMail.

GET

agent_mail_search_pod_threads

Search AgentMail threads scoped to a pod.

/v0/pods/{pod_id}/threads/search

6 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
q	string	required	Search query.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
before	string	optional	Only include records before this ISO 8601 timestamp.
after	string	optional	Only include records after this ISO 8601 timestamp.

GET

agent_mail_get_pod_thread

Get a single AgentMail thread scoped to a pod.

/v0/pods/{pod_id}/threads/{thread_id}

2 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
thread_id	string	required	The AgentMail thread identifier.

PATCH

agent_mail_update_pod_thread

Update labels on an AgentMail thread scoped to a pod.

/v0/pods/{pod_id}/threads/{thread_id}

4 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
thread_id	string	required	The AgentMail thread identifier.
add_labels	array	optional	Labels used to filter or apply to a record.
remove_labels	array	optional	Labels used to filter or apply to a record.

DELETE

agent_mail_delete_pod_thread

Delete an AgentMail thread scoped to a pod.

/v0/pods/{pod_id}/threads/{thread_id}

3 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
thread_id	string	required	The AgentMail thread identifier.
permanent	boolean	optional	Whether the thread should be permanently deleted.

GET

agent_mail_get_pod_thread_attachment

Get metadata and download URL for an attachment in an AgentMail pod thread.

/v0/pods/{pod_id}/threads/{thread_id}/attachments/{attachment_id}

3 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
thread_id	string	required	The AgentMail thread identifier.
attachment_id	string	required	The AgentMail attachment identifier.

GET

agent_mail_list_pod_drafts

List AgentMail drafts scoped to a pod.

/v0/pods/{pod_id}/drafts

7 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
labels	array	optional	Labels used to filter or apply to a record.
before	string	optional	Only include records before this ISO 8601 timestamp.
after	string	optional	Only include records after this ISO 8601 timestamp.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.

GET

agent_mail_get_pod_draft

Get a single AgentMail draft scoped to a pod.

/v0/pods/{pod_id}/drafts/{draft_id}

2 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
draft_id	string	required	The AgentMail draft identifier.

GET

agent_mail_get_pod_draft_attachment

Get metadata and download URL for an attachment on an AgentMail pod draft.

/v0/pods/{pod_id}/drafts/{draft_id}/attachments/{attachment_id}

3 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
draft_id	string	required	The AgentMail draft identifier.
attachment_id	string	required	The AgentMail attachment identifier.

GET

agent_mail_list_pod_domains

List AgentMail domains scoped to a pod.

/v0/pods/{pod_id}/domains

4 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.
ascending	boolean	optional	Whether results should be sorted in ascending timestamp order.

POST

agent_mail_create_pod_domain

Create an AgentMail domain scoped to a pod.

/v0/pods/{pod_id}/domains

3 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
domain	string	optional	Domain name to add to AgentMail.
feedback_enabled	boolean	optional	Whether bounce and complaint notifications are sent to inboxes.

GET

agent_mail_get_pod_domain

Get a single AgentMail domain scoped to a pod.

/v0/pods/{pod_id}/domains/{domain_id}

2 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
domain_id	string	required	The AgentMail domain identifier.

PATCH

agent_mail_update_pod_domain

Update an AgentMail domain scoped to a pod.

/v0/pods/{pod_id}/domains/{domain_id}

3 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
domain_id	string	required	The AgentMail domain identifier.
feedback_enabled	boolean	optional	Whether bounce and complaint notifications are sent to inboxes.

DELETE

agent_mail_delete_pod_domain

Delete an AgentMail domain scoped to a pod.

/v0/pods/{pod_id}/domains/{domain_id}

2 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
domain_id	string	required	The AgentMail domain identifier.

GET

agent_mail_get_pod_domain_zone_file

Get the DNS zone file records needed for an AgentMail pod domain.

/v0/pods/{pod_id}/domains/{domain_id}/zone-file

2 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
domain_id	string	required	The AgentMail domain identifier.

POST

agent_mail_verify_pod_domain

Ask AgentMail to verify a pod domain's DNS records.

/v0/pods/{pod_id}/domains/{domain_id}/verify

2 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
domain_id	string	required	The AgentMail domain identifier.

GET

agent_mail_list_pod_list_entries

List AgentMail allow or block entries scoped to a pod.

/v0/pods/{pod_id}/lists/{direction}/{type}

5 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.

POST

agent_mail_create_pod_list_entry

Create an AgentMail allow or block list entry scoped to a pod.

/v0/pods/{pod_id}/lists/{direction}/{type}

5 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
entry	string	required	The email address or domain list entry.
reason	string	optional	Reason for adding the list entry.

GET

agent_mail_get_pod_list_entry

Get an AgentMail allow or block list entry scoped to a pod.

/v0/pods/{pod_id}/lists/{direction}/{type}/{entry}

4 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
entry	string	required	The email address or domain list entry.

DELETE

agent_mail_delete_pod_list_entry

Delete an AgentMail allow or block list entry scoped to a pod.

/v0/pods/{pod_id}/lists/{direction}/{type}/{entry}

4 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
direction	string	required	Direction of the list entry.
type	string	required	Type of list entry.
entry	string	required	The email address or domain list entry.

GET

agent_mail_query_pod_metrics

Query AgentMail metrics scoped to a pod.

/v0/pods/{pod_id}/metrics

7 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
event_types	array	optional	Metric event types to query.
start	string	optional	Start timestamp for the metrics query.
end	string	optional	End timestamp for the metrics query.
period	integer	optional	Period in seconds for each metrics bucket.
limit	integer	optional	Maximum number of items to return.
descending	boolean	optional	Whether metrics should be sorted in descending timestamp order.

GET

agent_mail_list_pod_api_keys

List AgentMail API keys scoped to a pod.

/v0/pods/{pod_id}/api-keys

3 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
limit	integer	optional	Maximum number of items to return.
page_token	string	optional	Pagination token for the next page of results.

POST

agent_mail_create_pod_api_key

Create an API key scoped to a specific AgentMail pod.

/v0/pods/{pod_id}/api-keys

3 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
name	string	optional	Name of the API key.
permissions	object	optional	Granular AgentMail API key permissions.

DELETE

agent_mail_delete_pod_api_key

Delete an API key scoped to a specific AgentMail pod.

/v0/pods/{pod_id}/api-keys/{api_key_id}

2 parameters

Param	Type	Required	Description
pod_id	string	required	The AgentMail pod identifier.
api_key_id	string	required	The AgentMail API key identifier.

GET

agent_mail_get_organization

Get the AgentMail organization available to the current API key.

/v0/organizations

GET

agent_mail_who_am_i

Get AgentMail identity information for the current API key.

/v0/auth/me