> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Agent Mail

> AgentMail provides programmable email inboxes, messages, drafts, domains, webhooks, and related infrastructure for AI agents.

![Agent Mail logo](https://mintcdn.com/composio-preview/qzegrvAapILigeDI/images/toolkits/agent_mail.svg?fit=max\&auto=format\&n=qzegrvAapILigeDI\&q=85\&s=21007fd32f5d698154eb047e47645bde)

* **Category:** email
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 93
* **Triggers:** 1
* **Slug:** `AGENT_MAIL`
* **Version:** 20261101\_00

## Tools

> [accordion] Batch Get Messages
>
> **Slug:** `AGENT_MAIL_BATCH_GET_MESSAGES`
>
> Return metadata for up to 500 messages from one inbox in a single request. Compare count with limit to detect missing or restricted IDs. Source or target records with spam, blocked, unauthenticated, or trash labels may be hidden or reported not found when the API key lacks the corresponding label visibility permission.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> ID of the inbox containing all requested messages.
>
> **message\_ids** `array` *required*
>
> Message IDs to retrieve (up to 500). Duplicates are rejected by AgentMail; missing, cross-inbox, or restricted IDs are omitted from the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Update Message Labels
>
> **Slug:** `AGENT_MAIL_BATCH_UPDATE_MESSAGE_LABELS`
>
> Atomically add or remove the same labels on up to 50 messages in one inbox. Missing or restricted message IDs are omitted from the result. Source or target records with spam, blocked, unauthenticated, or trash labels may be hidden or reported not found when the API key lacks the corresponding label visibility permission.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox ID containing all target messages, usually its full email address.
>
> **add\_labels** `array`
>
> Labels to add to every resolved message.
>
> **message\_ids** `array` *required*
>
> Unique message IDs to update (up to 50), all from the specified inbox.
>
> **remove\_labels** `array`
>
> Labels to remove from every resolved message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Complete File Upload
>
> **Slug:** `AGENT_MAIL_COMPLETE_FILE_UPLOAD`
>
> Mark a pending Agent Drive file ready after its bytes have been PUT to the presigned URL returned by CREATE\_FILE. AgentMail verifies the exact declared size and SHA-256; calling this before a successful upload returns a conflict. Only a key with file\_read or the key that created the file can complete it. Agent Drive is a US-production-only Labs feature.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> ID returned by CREATE\_FILE.
>
> **inbox\_id** `string` *required*
>
> Inbox that owns the pending file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Agent Armor Feedback
>
> **Slug:** `AGENT_MAIL_CREATE_AGENT_ARMOR_FEEDBACK`
>
> Record whether Agent Armor's completed verdict on a message was correct. A message accepts up to 20 feedback records.
>
> #### Input Parameters
>
> **notes** `string`
>
> Additional context about the verdict.
>
> **feedback** `string ("correct_review" | "incorrect_review" | "missed_threat" | "legitimate_agent_instruction" | "spam_or_phishing")` *required*
>
> Assessment of Agent Armor's completed verdict.
>
> **inbox\_id** `string` *required*
>
> ID of the inbox containing the assessed message.
>
> **message\_id** `string` *required*
>
> ID of the message whose verdict is being assessed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Calendar Event
>
> **Slug:** `AGENT_MAIL_CREATE_CALENDAR_EVENT`
>
> Create a one-off or recurring event on a US-only inbox calendar. client\_id makes retries safe; send\_invites emails attendees and consumes send limits.
>
> #### Input Parameters
>
> **end** `string` *required*
>
> Local wall-clock end in the event time zone.
>
> **start** `string` *required*
>
> Local wall-clock start in the event time zone.
>
> **title** `string` *required*
>
> Event title.
>
> **status** `string ("confirmed" | "tentative" | "cancelled")`
>
> Initial status; defaults to confirmed.
>
> **all\_day** `boolean`
>
> Use date-only boundaries; defaults to false.
>
> **inbox\_id** `string` *required*
>
> Inbox whose calendar will own the event.
>
> **location** `string`
>
> Event location.
>
> **metadata** `string`
>
> Caller-owned JSON metadata, up to 16,384 bytes.
>
> **timezone** `string`
>
> IANA time zone; defaults to the calendar time zone.
>
> **attendees** `array`
>
> Event attendees.
>
> **client\_id** `string`
>
> Stable create idempotency key for safe retries.
>
> **recurrence** `object`
>
> RFC 5545 recurrence definition.
>
> **description** `string`
>
> Description, up to 65,536 UTF-8 bytes.
>
> **send\_invites** `boolean`
>
> Email every attendee an invitation; defaults to false.
>
> **duration\_mode** `string ("nominal" | "exact")`
>
> Duration behavior across daylight-saving transitions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Draft
>
> **Slug:** `AGENT_MAIL_CREATE_DRAFT`
>
> Create a draft, optionally scheduling its automatic delivery with send\_at.
>
> #### Input Parameters
>
> **cc** `array`
>
> CC recipient addresses
>
> **to** `array`
>
> Recipient addresses
>
> **bcc** `array`
>
> BCC recipient addresses
>
> **html** `string`
>
> HTML body of the draft
>
> **text** `string`
>
> Plain-text body of the draft
>
> **labels** `array`
>
> Labels to apply to the draft
>
> **send\_at** `string`
>
> Future time at which AgentMail should automatically send the draft
>
> **subject** `string`
>
> Subject of the draft
>
> **inbox\_id** `string` *required*
>
> ID of the AgentMail inbox, typically its full email address
>
> **reply\_to** `array`
>
> Reply-to addresses for the draft
>
> **client\_id** `string`
>
> Client-provided identifier for the draft
>
> **reply\_all** `boolean`
>
> Whether to address all recipients of the replied-to message
>
> **forward\_of** `string`
>
> Message ID to create this draft as a forward of
>
> **attachments** `array`
>
> Attachments to include in the draft
>
> **in\_reply\_to** `string`
>
> Message ID to create this draft as a reply to
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create File
>
> **Slug:** `AGENT_MAIL_CREATE_FILE`
>
> Initialize a pending Agent Drive file and return instructions for a direct storage upload. This does not upload bytes: PUT the exact bytes to the credential-sensitive presigned URL with every returned header unchanged and without the AgentMail API key, then call COMPLETE\_FILE\_UPLOAD. Identical requests are retry-safe. Pending files consume Drive quota immediately and expire after one day if incomplete; call DELETE\_FILE when abandoning an upload. Agent Drive is a US-production-only Labs feature.
>
> #### Input Parameters
>
> **path** `string` *required*
>
> Unique Unicode NFC path within the inbox drive, up to 1,024 UTF-8 bytes. Use slash-separated segments of at most 255 bytes, with no leading or trailing slash, empty, dot, or dot-dot segment, backslash, or invisible control character; for example reports/q3.pdf.
>
> **size** `integer` *required*
>
> Exact file size in bytes, up to 100 MiB.
>
> **sha256** `string` *required*
>
> Base64 encoding of the file's 32-byte SHA-256 digest: exactly 44 characters ending in '='.
>
> **inbox\_id** `string` *required*
>
> Inbox whose drive will contain the file.
>
> **expires\_at** `string`
>
> Future ISO 8601 expiry time. On a retry, send the expires\_at returned by the first response.
>
> **content\_type** `string`
>
> MIME type; omit to use application/octet-stream.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Inbox
>
> **Slug:** `AGENT_MAIL_CREATE_INBOX`
>
> Create a new AgentMail inbox via API. Returns the inbox\_id and email address for sending/receiving messages. Use when provisioning new inboxes for agents or workflows.
>
> #### Input Parameters
>
> **domain** `string`
>
> Domain for the inbox email address. Must be a verified domain in your AgentMail account. Defaults to 'agentmail.to' if not provided.
>
> **username** `string`
>
> Username for the inbox. Used to create the email address (username\@domain). If not provided, a random username will be generated.
>
> **client\_id** `string`
>
> Client-side identifier for idempotency or correlation. Can be used to prevent duplicate inbox creation or to associate the inbox with your internal systems.
>
> **display\_name** `string`
>
> Display name for the inbox (shown as the sender name in emails)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Inbox API Key
>
> **Slug:** `AGENT_MAIL_CREATE_INBOX_API_KEY`
>
> Create an inbox-scoped bearer key and return its one-time secret. Permissions can be specified to restrict the key.
>
> #### Input Parameters
>
> **name** `string`
>
> Human-readable name for the new API key
>
> **inbox\_id** `string` *required*
>
> Inbox identifier, typically its full email address
>
> **expires\_at** `string`
>
> Future expiration time in ISO 8601 format. Omit to inherit the authenticating key's expiration
>
> **permissions** `object`
>
> Permissions granted to the key. Omit to grant all permissions; when provided, only fields set to true are granted
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Inbox in Pod
>
> **Slug:** `AGENT_MAIL_CREATE_INBOX_IN_POD`
>
> Create an inbox inside an explicitly selected AgentMail pod, optionally choosing its address, initial status, idempotency ID, and metadata.
>
> #### Input Parameters
>
> **domain** `string`
>
> Verified address domain; omit to use agentmail.to.
>
> **pod\_id** `string` *required*
>
> ID of the pod in which to create the inbox.
>
> **status** `string ("active" | "paused")`
>
> Initial inbox status. Paused stops sending and silently drops incoming mail without bouncing or queueing it for delivery after resume.
>
> **metadata** `object`
>
> Custom string, number, or boolean metadata. Up to 256 entries; keys and string values are limited to 256 characters.
>
> **username** `string`
>
> Username portion of the inbox address; omit to generate one.
>
> **client\_id** `string`
>
> Caller-provided correlation or idempotency ID.
>
> **display\_name** `string`
>
> Display name used when the inbox sends email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Inbox Polling Webhook
>
> **Slug:** `AGENT_MAIL_CREATE_INBOX_POLLING_WEBHOOK`
>
> Create or resume a polling webhook scoped to one inbox. The inbox comes from the path, so organization selector lists are not accepted. AgentMail's polling guide currently says polling is US-only even though the API reference lists an EU server; follow the guide and do not assume EU support. The response contains a one-time credential-sensitive polling token; store it securely and never log or expose it.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox whose events this polling webhook queues.
>
> **client\_id** `string` *required*
>
> Required idempotency key for this consumer. Reusing it through this inbox route returns the existing subscription with a new token and immediately invalidates the old token.
>
> **event\_types** `array` *required*
>
> Complete non-empty list of event types to queue. There is no all-events default. Restricted spam, blocked, unauthenticated, security, and calendar events also require their matching label, message, or calendar read permission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Inbox Webhook
>
> **Slug:** `AGENT_MAIL_CREATE_INBOX_WEBHOOK`
>
> Create a regular webhook scoped to one AgentMail inbox for a non-empty set of event types. The response contains a credential-sensitive signature secret; never log or expose it.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> HTTP or HTTPS endpoint that receives webhook deliveries.
>
> **headers** `object`
>
> Custom delivery headers. Values are credential-sensitive and write-only: AgentMail never returns them. Never log or expose header values.
>
> **inbox\_id** `string` *required*
>
> ID of the inbox that will own the webhook.
>
> **client\_id** `string`
>
> Caller-provided ID for the webhook.
>
> **event\_types** `array` *required*
>
> Complete non-empty list of event types to deliver. There is no all-events default. Restricted spam, blocked, unauthenticated, security, and calendar events also require their matching label, message, or calendar read permission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Allowlist or Blocklist Entry
>
> **Slug:** `AGENT_MAIL_CREATE_LIST_ENTRY`
>
> Add an email address or domain to an organization-wide send, receive, or reply allowlist or blocklist.
>
> #### Input Parameters
>
> **entry** `string` *required*
>
> Email address or domain to add.
>
> **reason** `string`
>
> Reason for adding the entry.
>
> **direction** `string ("send" | "receive" | "reply")` *required*
>
> Mail direction governed by the list.
>
> **list\_type** `string ("allow" | "block")` *required*
>
> Whether to add to the allowlist or blocklist.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Pod
>
> **Slug:** `AGENT_MAIL_CREATE_POD`
>
> Create an AgentMail pod for grouping inboxes and related resources.
>
> #### Input Parameters
>
> **name** `string`
>
> Human-readable name for the pod.
>
> **client\_id** `string`
>
> Caller-provided idempotency identifier for safe retries.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Polling Webhook
>
> **Slug:** `AGENT_MAIL_CREATE_POLLING_WEBHOOK`
>
> Create or resume an organization-level polling webhook for a non-empty set of event types, optionally filtered to at most 10 inboxes and pods combined. Current provider polling support is US-only (api.agentmail.to); do not use this action with an EU connection. The response contains a one-time, credential-sensitive polling token; store it securely and never log or expose it.
>
> #### Input Parameters
>
> **pod\_ids** `array`
>
> Pod IDs whose events should be delivered. A listed pod already covers all of its inboxes.
>
> **client\_id** `string` *required*
>
> Required idempotency key for this consumer. Reusing it returns the same subscription with a new token and immediately invalidates the old token.
>
> **inbox\_ids** `array`
>
> Inbox IDs whose events should be delivered to the webhook.
>
> **event\_types** `array` *required*
>
> Complete non-empty list of event types to queue. There is no all-events default. Restricted spam, blocked, unauthenticated, security, and calendar events also require their matching label, message, or calendar read permission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Webhook
>
> **Slug:** `AGENT_MAIL_CREATE_WEBHOOK`
>
> Create an organization-level webhook for a non-empty set of event types, optionally filtered to at most 10 inboxes and pods combined. The response contains a credential-sensitive signature secret; never log or expose it.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> HTTP or HTTPS endpoint that receives webhook deliveries.
>
> **headers** `object`
>
> Custom delivery headers. Values are credential-sensitive and write-only: AgentMail never returns them. Never log or expose header values.
>
> **pod\_ids** `array`
>
> Pod IDs whose events should be delivered. A listed pod already covers all of its inboxes.
>
> **client\_id** `string`
>
> Caller-provided ID for the webhook.
>
> **inbox\_ids** `array`
>
> Inbox IDs whose events should be delivered to the webhook.
>
> **event\_types** `array` *required*
>
> Complete non-empty list of event types to deliver. There is no all-events default. Restricted spam, blocked, unauthenticated, security, and calendar events also require their matching label, message, or calendar read permission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Calendar Event
>
> **Slug:** `AGENT_MAIL_DELETE_CALENDAR_EVENT`
>
> Accept asynchronous deletion of a US-only calendar event or cancel recurring dates. If-Match guards the version and Idempotency-Key makes retries deterministic.
>
> #### Input Parameters
>
> **mode** `string ("single" | "future")`
>
> For a dated ID, cancel one date or it and all later dates.
>
> **event\_id** `string` *required*
>
> Event UUID or stable dated instance ID.
>
> **if\_match** `string`
>
> Current event ETag, or \*, for a conditional delete.
>
> **inbox\_id** `string` *required*
>
> Inbox that owns the event.
>
> **send\_invites** `boolean`
>
> Email every attendee a cancellation; defaults to false.
>
> **idempotency\_key** `string`
>
> Visible-ASCII retry key unique across the organization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Draft
>
> **Slug:** `AGENT_MAIL_DELETE_DRAFT`
>
> Permanently delete one unsent draft from an inbox.
>
> #### Input Parameters
>
> **draft\_id** `string` *required*
>
> Draft ID to permanently delete.
>
> **inbox\_id** `string` *required*
>
> Inbox that owns the draft.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete File
>
> **Slug:** `AGENT_MAIL_DELETE_FILE`
>
> Permanently delete a pending or ready Agent Drive file and free its path. A previously issued presigned download URL can remain valid until its expiry. Requires file\_delete, and only a key with file\_read or the key that created the file can delete it. Agent Drive is a US-production-only Labs feature.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> ID of the file to permanently delete.
>
> **inbox\_id** `string` *required*
>
> Inbox that owns the file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Inbox
>
> **Slug:** `AGENT_MAIL_DELETE_INBOX`
>
> Permanently delete one inbox by ID. AgentMail accepts the deletion asynchronously, so acceptance does not guarantee immediate completion.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox ID to permanently delete, usually its full email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Inbox Polling Webhook
>
> **Slug:** `AGENT_MAIL_DELETE_INBOX_POLLING_WEBHOOK`
>
> Permanently delete an inbox-scoped polling webhook by webhook\_id or client\_id, invalidate its polling token, and free its subscription slot. AgentMail's polling guide currently says polling is US-only even though the API reference lists an EU server; follow the guide and do not assume EU support.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox that owns the polling webhook.
>
> **webhook\_id** `string` *required*
>
> Polling webhook identifier. AgentMail accepts either its webhook\_id or its caller-provided client\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Inbox Webhook
>
> **Slug:** `AGENT_MAIL_DELETE_INBOX_WEBHOOK`
>
> Permanently delete a regular webhook created for a selected AgentMail inbox and stop future deliveries.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> ID of the inbox that owns the webhook.
>
> **webhook\_id** `string` *required*
>
> ID of the webhook to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Allowlist or Blocklist Entry
>
> **Slug:** `AGENT_MAIL_DELETE_LIST_ENTRY`
>
> Remove one email address or domain from an organization-wide send, receive, or reply allowlist or blocklist.
>
> #### Input Parameters
>
> **entry** `string` *required*
>
> Exact email address or domain to remove.
>
> **direction** `string ("send" | "receive" | "reply")` *required*
>
> Mail direction governed by the list.
>
> **list\_type** `string ("allow" | "block")` *required*
>
> Whether to remove from the allowlist or blocklist.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Message
>
> **Slug:** `AGENT_MAIL_DELETE_MESSAGE`
>
> Permanently delete one message from an inbox. Source or target records with spam, blocked, unauthenticated, or trash labels may be hidden or reported not found when the API key lacks the corresponding label visibility permission.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox containing the message.
>
> **message\_id** `string` *required*
>
> Message ID to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Pod
>
> **Slug:** `AGENT_MAIL_DELETE_POD`
>
> Permanently delete one AgentMail pod by its unique ID.
>
> #### Input Parameters
>
> **pod\_id** `string` *required*
>
> Unique ID of the pod to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Pod Inbox
>
> **Slug:** `AGENT_MAIL_DELETE_POD_INBOX`
>
> Permanently delete an inbox through its explicitly selected AgentMail pod, preserving the pod tenant boundary. A 202 response means deletion continues asynchronously; poll GET\_POD\_INBOX until it returns 404.
>
> #### Input Parameters
>
> **pod\_id** `string` *required*
>
> ID of the pod that owns the inbox.
>
> **inbox\_id** `string` *required*
>
> ID of the inbox to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Polling Webhook
>
> **Slug:** `AGENT_MAIL_DELETE_POLLING_WEBHOOK`
>
> Permanently delete an organization-level polling webhook by webhook\_id or client\_id, invalidate its polling token, and free its subscription slot. Current provider polling support is US-only (api.agentmail.to); do not use this action with an EU connection.
>
> #### Input Parameters
>
> **webhook\_id** `string` *required*
>
> Polling webhook identifier. AgentMail accepts either its webhook\_id or its caller-provided client\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Thread
>
> **Slug:** `AGENT_MAIL_DELETE_THREAD`
>
> Permanently delete one AgentMail thread and all of its messages.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> ID of the inbox containing the thread. Use AGENT\_MAIL\_LIST\_INBOXES to discover inbox IDs.
>
> **thread\_id** `string` *required*
>
> ID of the thread to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook
>
> **Slug:** `AGENT_MAIL_DELETE_WEBHOOK`
>
> Permanently delete an organization-level webhook and stop future deliveries.
>
> #### Input Parameters
>
> **webhook\_id** `string` *required*
>
> ID of the webhook to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Forward Message
>
> **Slug:** `AGENT_MAIL_FORWARD_MESSAGE`
>
> Immediately forward an existing message to new recipients with optional added content and attachments. Source or target records with spam, blocked, unauthenticated, or trash labels may be hidden or reported not found when the API key lacks the corresponding label visibility permission.
>
> #### Input Parameters
>
> **cc** `array`
>
> Cc recipient address or addresses.
>
> **to** `array`
>
> Primary recipient addresses for the forwarded message. Omit when the forward is addressed only with cc or bcc.
>
> **bcc** `array`
>
> Bcc recipient address or addresses.
>
> **html** `string`
>
> HTML content to add above the forwarded message.
>
> **text** `string`
>
> Plain-text content to add above the forwarded message.
>
> **labels** `array`
>
> Labels to apply to the forwarded message.
>
> **headers** `object`
>
> Additional outbound message headers.
>
> **subject** `string`
>
> Subject for the forwarded message; omit to use the generated subject.
>
> **inbox\_id** `string` *required*
>
> Inbox containing the message to forward.
>
> **reply\_to** `array`
>
> Reply-To address or addresses.
>
> **message\_id** `string` *required*
>
> ID of the message to forward.
>
> **attachments** `array`
>
> Additional attachments to include with the forwarded message.
>
> **track\_opens** `boolean`
>
> Whether to track the first open when the account and HTML body support it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Agenda
>
> **Slug:** `AGENT_MAIL_GET_AGENDA`
>
> Get one page of non-cancelled calendar dates in a UTC window, expanding recurring events and ordering dates by start time. Calendar is available only in US production.
>
> #### Input Parameters
>
> **after** `string`
>
> Window start as a UTC timestamp ending in Z.
>
> **limit** `integer`
>
> Maximum agenda items; defaults to 50.
>
> **before** `string`
>
> Window end as a UTC timestamp ending in Z.
>
> **inbox\_id** `string` *required*
>
> Inbox whose expanded agenda to retrieve.
>
> **page\_token** `string`
>
> Continuation token from a previous call; omit for the first page.
>
> **consistency** `string ("eventual" | "primary")`
>
> Use primary to read completed writes immediately.
>
> **include\_overlapping** `boolean`
>
> Include events already running at after; AgentMail defaults to true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get API Key
>
> **Slug:** `AGENT_MAIL_GET_API_KEY`
>
> Retrieve API-key metadata without exposing bearer secret values.
>
> #### Input Parameters
>
> **api\_key\_id** `string` *required*
>
> API-key ID, or client\_id alias for a public-key credential
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Calendar
>
> **Slug:** `AGENT_MAIL_GET_CALENDAR`
>
> Get an inbox's US-only calendar settings, event count, and ETag. Use primary consistency to read a just-completed write.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox whose calendar to retrieve.
>
> **consistency** `string ("eventual" | "primary")`
>
> Use primary to read completed writes immediately.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Calendar Event
>
> **Slug:** `AGENT_MAIL_GET_CALENDAR_EVENT`
>
> Get the full current form of a US-only calendar event or recurring-event date, including its opaque ETag for conditional mutations.
>
> #### Input Parameters
>
> **event\_id** `string` *required*
>
> Event UUID or stable dated instance ID.
>
> **inbox\_id** `string` *required*
>
> Inbox that owns the event.
>
> **consistency** `string ("eventual" | "primary")`
>
> Use primary to read completed writes immediately.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current Identity
>
> **Slug:** `AGENT_MAIL_GET_CURRENT_IDENTITY`
>
> Return the connected AgentMail identity and its organization, pod, or inbox access boundary without exposing the credential itself.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Domain
>
> **Slug:** `AGENT_MAIL_GET_DOMAIN`
>
> Return an AgentMail custom domain, its domain and tracking verification statuses, and all required DNS records.
>
> #### Input Parameters
>
> **domain\_id** `string` *required*
>
> AgentMail domain ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Domain Setup Link
>
> **Slug:** `AGENT_MAIL_GET_DOMAIN_SETUP_LINK`
>
> Build a one-click Domain Connect DNS setup link when supported. The returned signed URL must be delivered privately to the intended domain owner. Retain the sensitive state ephemerally and compare it on redirect; do not log either value.
>
> #### Input Parameters
>
> **domain\_id** `string` *required*
>
> AgentMail domain ID for which to build a one-click DNS setup link.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Domain Zone File
>
> **Slug:** `AGENT_MAIL_GET_DOMAIN_ZONE_FILE`
>
> Download the AgentMail-generated DNS zone file for a custom domain as a bounded binary file reference.
>
> #### Input Parameters
>
> **domain\_id** `string` *required*
>
> AgentMail domain ID whose DNS zone file to download.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Draft
>
> **Slug:** `AGENT_MAIL_GET_DRAFT`
>
> Retrieve the complete contents and scheduling details of one draft.
>
> #### Input Parameters
>
> **draft\_id** `string` *required*
>
> ID of the draft to retrieve
>
> **inbox\_id** `string` *required*
>
> ID of the AgentMail inbox containing the draft
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Draft Attachment
>
> **Slug:** `AGENT_MAIL_GET_DRAFT_ATTACHMENT`
>
> Get a temporary download reference for one draft attachment.
>
> #### Input Parameters
>
> **draft\_id** `string` *required*
>
> Draft containing the attachment.
>
> **attachment\_id** `string` *required*
>
> Attachment ID returned by the draft read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get File
>
> **Slug:** `AGENT_MAIL_GET_FILE`
>
> Get Agent Drive file metadata. A ready file can include a credential-sensitive presigned download URL valid for up to one hour; treat it as a secret and never log or expose it. Requires file\_read. Agent Drive is a US-production-only Labs feature.
>
> #### Input Parameters
>
> **file\_id** `string` *required*
>
> ID of the file to retrieve.
>
> **inbox\_id** `string` *required*
>
> Inbox that owns the file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Inbox
>
> **Slug:** `AGENT_MAIL_GET_INBOX`
>
> Retrieve one AgentMail inbox and its metadata by ID or email address.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox ID or email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Inbox Polling Webhook
>
> **Slug:** `AGENT_MAIL_GET_INBOX_POLLING_WEBHOOK`
>
> Get one inbox-scoped polling webhook by webhook\_id or client\_id. AgentMail's polling guide currently says polling is US-only even though the API reference lists an EU server; follow the guide and do not assume EU support. The polling token is never returned; create again with the same client\_id to issue a new token.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox that owns the polling webhook.
>
> **webhook\_id** `string` *required*
>
> Polling webhook identifier. AgentMail accepts either its webhook\_id or its caller-provided client\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Inbox Webhook
>
> **Slug:** `AGENT_MAIL_GET_INBOX_WEBHOOK`
>
> Get one regular webhook created for a selected AgentMail inbox. The response contains a credential-sensitive signature secret; never log or expose it.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> ID of the inbox that owns the webhook.
>
> **webhook\_id** `string` *required*
>
> ID of the webhook to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Inbox Webhook Headers
>
> **Slug:** `AGENT_MAIL_GET_INBOX_WEBHOOK_HEADERS`
>
> List only the names of custom delivery headers on an inbox-scoped regular webhook. Header values are credential-sensitive, write-only, and never returned.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> ID of the inbox that owns the webhook.
>
> **webhook\_id** `string` *required*
>
> ID of the webhook whose custom header names to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Message
>
> **Slug:** `AGENT_MAIL_GET_MESSAGE`
>
> Retrieve an email message from an AgentMail inbox, including sender, recipients, labels, and available subject, body and attachment metadata. Use it to read individual messages discovered through message listing or webhooks.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> MUST be a valid email address (e.g., [agent@agentmail.to](mailto:agent@agentmail.to)). This is NOT an ID or identifier - it must be a full email address of the inbox.
>
> **message\_id** `string` *required*
>
> The unique message identifier (NOT an email address). Get this from the 'message\_id' field returned by LIST\_MESSAGES.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Message Attachment
>
> **Slug:** `AGENT_MAIL_GET_MESSAGE_ATTACHMENT`
>
> Get a temporary download reference for one message attachment. Source or target records with spam, blocked, unauthenticated, or trash labels may be hidden or reported not found when the API key lacks the corresponding label visibility permission.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox containing the message.
>
> **message\_id** `string` *required*
>
> Message containing the attachment.
>
> **attachment\_id** `string` *required*
>
> Attachment ID returned by the message read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization
>
> **Slug:** `AGENT_MAIL_GET_ORGANIZATION`
>
> Return the connected AgentMail organization's identifiers, current inbox and domain counts, configured resource limits, and timestamps.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pod
>
> **Slug:** `AGENT_MAIL_GET_POD`
>
> Retrieve one AgentMail pod by its unique ID.
>
> #### Input Parameters
>
> **pod\_id** `string` *required*
>
> Unique ID of the pod to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pod Inbox
>
> **Slug:** `AGENT_MAIL_GET_POD_INBOX`
>
> Get an AgentMail inbox through an explicitly selected pod, preserving the pod tenant boundary.
>
> #### Input Parameters
>
> **pod\_id** `string` *required*
>
> ID of the pod that must own the inbox.
>
> **inbox\_id** `string` *required*
>
> ID of the inbox to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Polling Webhook
>
> **Slug:** `AGENT_MAIL_GET_POLLING_WEBHOOK`
>
> Get one organization-level polling webhook by webhook\_id or client\_id. Current provider polling support is US-only (api.agentmail.to); do not use this action with an EU connection. The polling token is never returned; create again with the same client\_id to issue a new token.
>
> #### Input Parameters
>
> **webhook\_id** `string` *required*
>
> Polling webhook identifier. AgentMail accepts either its webhook\_id or its caller-provided client\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Raw Message
>
> **Slug:** `AGENT_MAIL_GET_RAW_MESSAGE`
>
> Get a temporary download reference for one message's raw RFC 5322 source, including its original headers and MIME structure. Source or target records with spam, blocked, unauthenticated, or trash labels may be hidden or reported not found when the API key lacks the corresponding label visibility permission.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> ID of the inbox containing the message, usually its full email address.
>
> **message\_id** `string` *required*
>
> ID of the message whose raw RFC 5322 source to download.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Thread
>
> **Slug:** `AGENT_MAIL_GET_THREAD`
>
> Retrieve one AgentMail thread and a paginated page of its messages.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of messages to return in this page (1-100).
>
> **inbox\_id** `string` *required*
>
> ID of the inbox containing the thread. Use AGENT\_MAIL\_LIST\_INBOXES to discover inbox IDs.
>
> **thread\_id** `string` *required*
>
> The thread ID to retrieve.
>
> **page\_token** `string`
>
> Token from a previous response for retrieving the next, older page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Thread Attachment
>
> **Slug:** `AGENT_MAIL_GET_THREAD_ATTACHMENT`
>
> Get a temporary download reference for an attachment using its thread and attachment IDs. Source or target records with spam, blocked, unauthenticated, or trash labels may be hidden or reported not found when the API key lacks the corresponding label visibility permission.
>
> #### Input Parameters
>
> **thread\_id** `string` *required*
>
> Thread containing the attachment.
>
> **attachment\_id** `string` *required*
>
> Attachment ID returned by a thread or message read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webhook
>
> **Slug:** `AGENT_MAIL_GET_WEBHOOK`
>
> Get one organization-level webhook configuration by ID. The response contains a credential-sensitive signature secret; never log or expose it.
>
> #### Input Parameters
>
> **webhook\_id** `string` *required*
>
> ID of the webhook to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webhook Headers
>
> **Slug:** `AGENT_MAIL_GET_WEBHOOK_HEADERS`
>
> List only the names of custom delivery headers on an organization-level webhook. Header values are credential-sensitive, write-only, and never returned.
>
> #### Input Parameters
>
> **webhook\_id** `string` *required*
>
> ID of the webhook whose headers to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Calendar Event Instances
>
> **Slug:** `AGENT_MAIL_LIST_CALENDAR_EVENT_INSTANCES`
>
> List one page of non-cancelled dates computed for a recurring US-only calendar event in a UTC window, including dates beyond the agenda horizon.
>
> #### Input Parameters
>
> **after** `string`
>
> Window start as a UTC timestamp ending in Z.
>
> **limit** `integer`
>
> Maximum dates to return; defaults to 50.
>
> **before** `string`
>
> Window end as a UTC timestamp ending in Z.
>
> **event\_id** `string` *required*
>
> UUID of the recurring event.
>
> **inbox\_id** `string` *required*
>
> Inbox that owns the recurring event.
>
> **page\_token** `string`
>
> Continuation token from a previous call; omit for the first page.
>
> **consistency** `string ("eventual" | "primary")`
>
> Use primary to read completed writes immediately.
>
> **include\_overlapping** `boolean`
>
> Include dates already running at after; defaults to true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Calendar Events
>
> **Slug:** `AGENT_MAIL_LIST_CALENDAR_EVENTS`
>
> List one US-only calendar page of stored one-off events, recurring series, and edited series dates, including cancelled events, by most recent update.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum events to return; defaults to 50.
>
> **inbox\_id** `string` *required*
>
> Inbox whose stored calendar events to list.
>
> **page\_token** `string`
>
> Continuation token from a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Domains
>
> **Slug:** `AGENT_MAIL_LIST_DOMAINS`
>
> List one page of AgentMail custom domains and return the continuation token for the next page.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of domains to return on this page.
>
> **ascending** `boolean`
>
> Sort in ascending creation-time order when true.
>
> **page\_token** `string`
>
> Continuation token from a previous response's `next_page_token`; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Drafts
>
> **Slug:** `AGENT_MAIL_LIST_DRAFTS`
>
> List unsent drafts in an AgentMail inbox with filters and pagination.
>
> #### Input Parameters
>
> **after** `string`
>
> Return drafts updated after this ISO 8601 timestamp
>
> **limit** `integer`
>
> Maximum number of drafts to return
>
> **before** `string`
>
> Return drafts updated before this ISO 8601 timestamp
>
> **labels** `array`
>
> Return drafts having these labels
>
> **inbox\_id** `string` *required*
>
> ID of the AgentMail inbox, typically its full email address
>
> **ascending** `boolean`
>
> Sort drafts in ascending temporal order when true
>
> **page\_token** `string`
>
> Token returned by a previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Files
>
> **Slug:** `AGENT_MAIL_LIST_FILES`
>
> List one page of an inbox's Agent Drive files in path order, including pending files. List items intentionally contain no presigned download URL; call GET\_FILE for one. Requires file\_read. Agent Drive is a US-production-only Labs feature.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Page size, 100 by default and at most 500.
>
> **inbox\_id** `string` *required*
>
> Inbox whose drive files to list.
>
> **ascending** `boolean`
>
> Sort paths ascending when true (the default), or descending when false.
>
> **page\_token** `string`
>
> Opaque continuation token from this action's previous response. It retains the inbox and filter context; omit other parameters when continuing.
>
> **path\_prefix** `string`
>
> Return only files whose path starts with this character prefix; it need not end at a path-segment boundary.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Inbox API Keys
>
> **Slug:** `AGENT_MAIL_LIST_INBOX_API_KEYS`
>
> List API-key metadata scoped to an inbox without exposing secret values.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of API-key records to return
>
> **inbox\_id** `string` *required*
>
> ID of the inbox whose API-key metadata should be listed
>
> **page\_token** `string`
>
> Token returned by a previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Inboxes
>
> **Slug:** `AGENT_MAIL_LIST_INBOXES`
>
> List a page of inboxes available to the authenticated AgentMail account. Use this to discover inbox\_id values for message operations; follow the next page token to retrieve more results.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of inboxes to return per page
>
> **ascending** `boolean`
>
> Sort inboxes in ascending order by created\_at timestamp (oldest first). Default is descending (newest first)
>
> **page\_token** `string`
>
> Token for pagination to get the next set of results
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Inbox Events
>
> **Slug:** `AGENT_MAIL_LIST_INBOX_EVENTS`
>
> List label-change events from an AgentMail inbox.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of events to return
>
> **inbox\_id** `string` *required*
>
> ID of the AgentMail inbox, typically its full email address
>
> **ascending** `boolean`
>
> Sort events in ascending temporal order when true
>
> **page\_token** `string`
>
> Token returned by a previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Inbox Polling Webhooks
>
> **Slug:** `AGENT_MAIL_LIST_INBOX_POLLING_WEBHOOKS`
>
> List polling webhooks created through one inbox route. Returns one page and an endpoint- and inbox-bound opaque continuation token. AgentMail's polling guide currently says polling is US-only even though the API reference lists an EU server; follow the guide and do not assume EU support. Polling tokens are never returned.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of polling webhooks to return on this page.
>
> **inbox\_id** `string` *required*
>
> Inbox whose polling webhooks to list.
>
> **ascending** `boolean`
>
> Return polling webhooks in ascending creation-time order (oldest first).
>
> **page\_token** `string`
>
> Opaque continuation token from this action's previous response. Tokens from other inboxes or list endpoints are rejected. Omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Inbox Webhooks
>
> **Slug:** `AGENT_MAIL_LIST_INBOX_WEBHOOKS`
>
> List one page of regular webhooks created for a selected AgentMail inbox. Responses contain credential-sensitive signature secrets; never log or expose them.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of webhooks to return on this page.
>
> **inbox\_id** `string` *required*
>
> ID of the inbox whose webhooks to list.
>
> **ascending** `boolean`
>
> Return webhooks in ascending creation-time order (oldest first).
>
> **page\_token** `string`
>
> Opaque continuation token from this action's previous response. It retains the inbox and list options; omit other parameters when continuing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Allowlist or Blocklist Entries
>
> **Slug:** `AGENT_MAIL_LIST_LIST_ENTRIES`
>
> List one page of organization-wide send, receive, or reply allowlist or blocklist entries. Supply entry to retrieve one exact email address or domain.
>
> #### Input Parameters
>
> **entry** `string`
>
> Exact email address or domain to retrieve; omit to list entries.
>
> **limit** `integer`
>
> Maximum number of entries to return on this page.
>
> **direction** `string ("send" | "receive" | "reply")` *required*
>
> Mail direction governed by the list.
>
> **list\_type** `string ("allow" | "block")` *required*
>
> Whether to inspect the allowlist or blocklist.
>
> **page\_token** `string`
>
> Opaque continuation token from a previous list call. Omit for the first page; ignored when entry is supplied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Messages
>
> **Slug:** `AGENT_MAIL_LIST_MESSAGES`
>
> List messages from an AgentMail inbox. Returns a `messages` array; each message uses `message_id` and `timestamp` fields (not `id`, `date`, or `items`).
>
> #### Input Parameters
>
> **after** `string`
>
> Return messages sent after this timestamp (ISO 8601 format)
>
> **limit** `integer`
>
> Maximum number of messages to return (1-100)
>
> **before** `string`
>
> Return messages sent before this timestamp (ISO 8601 format)
>
> **labels** `array`
>
> Filter messages by labels (e.g., 'sent', 'unread', 'important')
>
> **inbox\_id** `string` *required*
>
> MUST be a valid email address (e.g., [agent@agentmail.to](mailto:agent@agentmail.to)). This is NOT an ID or identifier - it must be a full email address of the inbox.
>
> **ascending** `boolean`
>
> Sort messages in ascending order by timestamp (oldest first). Default is descending (newest first)
>
> **page\_token** `string`
>
> Token for pagination to get the next set of results
>
> **include\_spam** `boolean`
>
> Include messages marked as spam in the results
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pod Inboxes
>
> **Slug:** `AGENT_MAIL_LIST_POD_INBOXES`
>
> List one page of inboxes inside an explicitly selected AgentMail pod, or supply query to search addresses and display names. Follow next\_page\_token until absent, including after an empty search page.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of inboxes to return on this page.
>
> **query** `string`
>
> Address or display-name text to search by word prefix. Omit for a chronological list.
>
> **pod\_id** `string` *required*
>
> ID of the pod whose inboxes should be listed or searched.
>
> **ascending** `boolean`
>
> Return oldest inboxes first when listing.
>
> **page\_token** `string`
>
> Opaque continuation token from a previous call. It retains the pod and list or search context; omit other parameters when continuing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Pods
>
> **Slug:** `AGENT_MAIL_LIST_PODS`
>
> Return one page of AgentMail pods and its continuation token.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of pods to return on this page.
>
> **ascending** `boolean`
>
> Return pods from oldest to newest by creation time when true.
>
> **page\_token** `string`
>
> Continuation token from a previous call. Omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Polling Webhooks
>
> **Slug:** `AGENT_MAIL_LIST_POLLING_WEBHOOKS`
>
> List organization-level polling webhooks created through the organization route. Returns one page and an endpoint-bound opaque continuation token. Current provider polling support is US-only (api.agentmail.to); do not use this action with an EU connection. Polling tokens are never returned.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of polling webhooks to return on this page.
>
> **ascending** `boolean`
>
> Return polling webhooks in ascending creation-time order (oldest first).
>
> **page\_token** `string`
>
> Opaque continuation token from this action's previous response. Tokens from other list endpoints are rejected. Omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Threads
>
> **Slug:** `AGENT_MAIL_LIST_THREADS`
>
> List conversation threads in an AgentMail inbox with filters.
>
> #### Input Parameters
>
> **after** `string`
>
> Return threads after this ISO 8601 timestamp.
>
> **limit** `integer`
>
> Maximum number of threads to return (1-100).
>
> **before** `string`
>
> Return threads before this ISO 8601 timestamp.
>
> **labels** `array`
>
> Labels that threads must match.
>
> **senders** `array`
>
> Sender substrings that must all match. Repeatable.
>
> **subject** `array`
>
> Subject substrings that must all match. Repeatable.
>
> **inbox\_id** `string` *required*
>
> ID of the inbox whose threads should be listed. Use AGENT\_MAIL\_LIST\_INBOXES to discover inbox IDs.
>
> **ascending** `boolean`
>
> Sort in ascending temporal order.
>
> **page\_token** `string`
>
> Token returned by a previous page.
>
> **recipients** `array`
>
> Recipient substrings that must all match. Repeatable.
>
> **include\_spam** `boolean`
>
> Include spam threads.
>
> **include\_trash** `boolean`
>
> Include trashed threads.
>
> **include\_blocked** `boolean`
>
> Include blocked threads.
>
> **include\_unauthenticated** `boolean`
>
> Include unauthenticated threads.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhooks
>
> **Slug:** `AGENT_MAIL_LIST_WEBHOOKS`
>
> List AgentMail webhook configurations.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of webhooks to return
>
> **ascending** `boolean`
>
> Sort webhooks in ascending creation order when true
>
> **page\_token** `string`
>
> Token returned by a previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Inbox Event Metrics
>
> **Slug:** `AGENT_MAIL_QUERY_INBOX_EVENT_METRICS`
>
> Query timestamped email-event counts for an AgentMail inbox.
>
> #### Input Parameters
>
> **end** `string`
>
> End of the query range as an ISO 8601 timestamp.
>
> **limit** `integer`
>
> Maximum number of metric buckets to return.
>
> **start** `string`
>
> Start of the query range as an ISO 8601 timestamp within the last 90 days.
>
> **period** `integer`
>
> Size of each aggregate time bucket in seconds (1-86400). Omit for individual event counts.
>
> **inbox\_id** `string` *required*
>
> Email address identifying the AgentMail inbox.
>
> **descending** `boolean`
>
> Whether to return buckets in descending timestamp order.
>
> **event\_types** `array`
>
> Event types to include. Each value is sent as a repeated query parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Metrics
>
> **Slug:** `AGENT_MAIL_QUERY_METRICS`
>
> Query organization-wide email event counts or cumulative resource-usage time series over a bounded time range.
>
> #### Input Parameters
>
> **end** `string`
>
> Exclusive end timestamp; future values are clamped to the current time.
>
> **limit** `integer`
>
> Maximum number of points to return in each metric series.
>
> **start** `string`
>
> Inclusive start timestamp, which must be within the last 90 days; defaults to 24 hours ago.
>
> **period** `integer`
>
> Time-bucket size in whole seconds from 1 to 86400; omit for individual event counts.
>
> **descending** `boolean`
>
> Return metric points from newest to oldest.
>
> **event\_types** `array`
>
> Event series to return for events metrics; omit to return every type.
>
> **metric\_kind** `string ("events" | "usage")` *required*
>
> Query email and domain event counts or cumulative resource usage.
>
> **usage\_types** `array`
>
> Usage series to return for usage metrics; omit to return every type valid at organization scope.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Rate Metrics
>
> **Slug:** `AGENT_MAIL_QUERY_RATE_METRICS`
>
> Query organization-wide rolling bounce and complaint rates.
>
> #### Input Parameters
>
> **end** `string`
>
> End of the query range as an ISO 8601 timestamp.
>
> **limit** `integer`
>
> Maximum number of metric buckets to return.
>
> **start** `string`
>
> Start of the query range as an ISO 8601 timestamp within the last 90 days.
>
> **period** `integer`
>
> Size of each sampling period in seconds (60-86400).
>
> **window** `integer`
>
> Size of the rolling window in seconds, up to 2592000 and a whole multiple of period. The range plus window may span at most 1000 periods.
>
> **descending** `boolean`
>
> Whether to return buckets in descending timestamp order.
>
> **rate\_types** `array`
>
> Rate series to include. Each value is sent as a repeated query parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Release Held Message
>
> **Slug:** `AGENT_MAIL_RELEASE_HELD_MESSAGE`
>
> Release a message that Agent Armor held for review, emit its delivery and security override events, and remove the agent-armor-held label. Only a still-held message with a review verdict can be released.
>
> #### Input Parameters
>
> **reason** `string` *required*
>
> Why the message is safe to release; must not be blank.
>
> **inbox\_id** `string` *required*
>
> ID of the inbox containing the held message.
>
> **message\_id** `string` *required*
>
> ID of the held message to release.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Reply To Message
>
> **Slug:** `AGENT_MAIL_REPLY_TO_MESSAGE`
>
> Reply to a selected message while preserving its AgentMail thread.
>
> #### Input Parameters
>
> **cc** `string`
>
> CC recipient addresses
>
> **to** `string`
>
> Recipient addresses overriding the default recipient
>
> **bcc** `string`
>
> BCC recipient addresses
>
> **html** `string`
>
> HTML body of the reply
>
> **text** `string`
>
> Plain-text body of the reply
>
> **labels** `array`
>
> Labels to apply to the reply
>
> **headers** `object`
>
> Additional headers to include in the reply
>
> **inbox\_id** `string` *required*
>
> ID of the AgentMail inbox containing the original message
>
> **reply\_to** `string`
>
> Reply-to addresses for the reply
>
> **reply\_all** `boolean`
>
> Whether to reply to all recipients of the original message
>
> **message\_id** `string` *required*
>
> ID of the message to reply to
>
> **attachments** `array`
>
> Attachments to include in the reply. Each attachment must provide base64 content or a downloadable url.
>
> **track\_opens** `boolean`
>
> Whether to track the first open; requires tracking and an HTML body
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Respond to Calendar Event
>
> **Slug:** `AGENT_MAIL_RESPOND_TO_CALENDAR_EVENT`
>
> Accept, decline, or tentatively accept an email invitation on a US-only inbox calendar. By default AgentMail emails the organizer; If-Match guards the response.
>
> #### Input Parameters
>
> **status** `string ("accepted" | "declined" | "tentative")` *required*
>
> Inbox's response to the invitation.
>
> **comment** `string`
>
> Response comment, up to 4,096 UTF-8 bytes.
>
> **event\_id** `string` *required*
>
> Event UUID or dated instance ID to respond to.
>
> **if\_match** `string`
>
> Current event ETag, or \*, for a conditional response.
>
> **inbox\_id** `string` *required*
>
> Invited inbox responding to the event.
>
> **send\_reply** `boolean`
>
> Email the organizer; AgentMail defaults to true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Draft
>
> **Slug:** `AGENT_MAIL_SEND_DRAFT`
>
> Immediately send and consume a draft, optionally changing message labels.
>
> #### Input Parameters
>
> **draft\_id** `string` *required*
>
> ID of the draft to send
>
> **inbox\_id** `string` *required*
>
> ID of the AgentMail inbox containing the draft
>
> **add\_labels** `string`
>
> Labels to add to the resulting sent message
>
> **remove\_labels** `string`
>
> Labels to remove from the resulting sent message
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Email
>
> **Slug:** `AGENT_MAIL_SEND_EMAIL`
>
> Send an email using AgentMail API
>
> #### Input Parameters
>
> **cc** `array`
>
> List of CC recipient email addresses
>
> **to** `array` *required*
>
> List of recipient email addresses
>
> **bcc** `array`
>
> List of BCC recipient email addresses
>
> **html** `string`
>
> HTML content of the email. Either text or html (or both) must be provided. If both are provided, email clients will typically prefer HTML with text as fallback.
>
> **text** `string`
>
> Plain text content of the email. Either text or html (or both) must be provided.
>
> **labels** `array`
>
> Labels to apply to the sent message
>
> **subject** `string` *required*
>
> Email subject line
>
> **inbox\_id** `string` *required*
>
> The inbox identifier (typically the full email address, e.g., '[your-inbox@agentmail.to](mailto:your-inbox@agentmail.to)'). Use AGENT\_MAIL\_LIST\_INBOXES to discover available inbox IDs, or AGENT\_MAIL\_CREATE\_INBOX to create a new inbox.
>
> **reply\_to** `array`
>
> Reply-to email addresses
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Message
>
> **Slug:** `AGENT_MAIL_SEND_MESSAGE`
>
> Immediately send a new email from an AgentMail inbox with optional HTML, attachments, custom headers, labels, and open tracking. Use a draft instead when the message must be scheduled for later.
>
> #### Input Parameters
>
> **cc** `array`
>
> Cc recipient address or addresses.
>
> **to** `array`
>
> Primary recipient address or addresses. Each may be an email address or a display-name address such as 'Ada \<[ada@example.com](mailto:ada@example.com)>'; AgentMail also accepts messages addressed only with cc or bcc.
>
> **bcc** `array`
>
> Bcc recipient address or addresses.
>
> **html** `string`
>
> HTML body, when provided.
>
> **text** `string`
>
> Plain-text body, when provided.
>
> **labels** `array`
>
> Labels to apply to the sent message.
>
> **headers** `object`
>
> Additional outbound email headers.
>
> **subject** `string`
>
> Email subject, when provided.
>
> **inbox\_id** `string` *required*
>
> ID of the inbox to send from, usually its full email address.
>
> **reply\_to** `array`
>
> Reply-To address or addresses.
>
> **attachments** `array`
>
> Attachments supplied as base64 content or public/pre-signed URLs.
>
> **track\_opens** `boolean`
>
> Track the first open. Requires an HTML body and a verified custom domain with open tracking enabled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Calendar
>
> **Slug:** `AGENT_MAIL_UPDATE_CALENDAR`
>
> Change an inbox calendar's default time zone in US production. Existing events retain their own time zones; optionally guard the update with If-Match.
>
> #### Input Parameters
>
> **if\_match** `string`
>
> Current calendar ETag, or \*, for a conditional update.
>
> **inbox\_id** `string` *required*
>
> Inbox whose calendar to update.
>
> **timezone** `string` *required*
>
> New default IANA time zone for subsequently created events.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Calendar Event
>
> **Slug:** `AGENT_MAIL_UPDATE_CALENDAR_EVENT`
>
> Patch a US-only calendar event, one recurring date, or that date and future dates. Explicit null clears only documented nullable fields; If-Match prevents overwrites.
>
> #### Input Parameters
>
> **end** `string`
>
> Replacement local wall-clock end.
>
> **mode** `string ("single" | "future")`
>
> For a dated ID, change one date or it and all later dates.
>
> **start** `string`
>
> Replacement local wall-clock start.
>
> **title** `string`
>
> Replacement title.
>
> **status** `string ("confirmed" | "tentative" | "cancelled")`
>
> Replacement event status.
>
> **all\_day** `boolean`
>
> Replacement all-day setting.
>
> **event\_id** `string` *required*
>
> Event UUID or stable dated instance ID.
>
> **if\_match** `string`
>
> Current event ETag, or \*, for a conditional update.
>
> **inbox\_id** `string` *required*
>
> Inbox that owns the event.
>
> **location** `string`
>
> Replacement location; null clears it.
>
> **metadata** `string`
>
> Replacement JSON metadata; null clears it.
>
> **timezone** `string`
>
> Replacement IANA time zone.
>
> **attendees** `array`
>
> Replacement attendee list.
>
> **recurrence** `object`
>
> Replacement recurrence; null turns an eligible series into one-off.
>
> **description** `string`
>
> Replacement description; null clears it.
>
> **send\_invites** `boolean`
>
> Email the updated invitation to every attendee.
>
> **duration\_mode** `string ("nominal" | "exact")`
>
> Replacement duration behavior.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Draft
>
> **Slug:** `AGENT_MAIL_UPDATE_DRAFT`
>
> Edit a draft, reschedule delivery, or cancel a scheduled send with null.
>
> #### Input Parameters
>
> **cc** `array`
>
> CC recipient addresses; pass null or an empty list to clear them
>
> **to** `array`
>
> Recipient addresses; pass null or an empty list to clear them
>
> **bcc** `array`
>
> BCC recipient addresses; pass null or an empty list to clear them
>
> **html** `string`
>
> HTML body; pass null to clear it
>
> **text** `string`
>
> Plain-text body; pass null to clear it
>
> **send\_at** `string`
>
> Future automatic-send time; pass null to cancel a scheduled send
>
> **subject** `string`
>
> Subject of the draft; pass null to clear it
>
> **draft\_id** `string` *required*
>
> ID of the draft to update
>
> **inbox\_id** `string` *required*
>
> ID of the AgentMail inbox, typically its full email address
>
> **reply\_to** `array`
>
> Reply-to addresses; pass null or an empty list to clear them
>
> **add\_labels** `array`
>
> Labels to add to the draft
>
> **remove\_labels** `array`
>
> Labels to remove from the draft
>
> **add\_attachments** `array`
>
> Attachments to add to the draft
>
> **remove\_attachments** `array`
>
> IDs of attachments to remove from the draft
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Inbox
>
> **Slug:** `AGENT_MAIL_UPDATE_INBOX`
>
> Update an inbox's display name, status, or custom metadata.
>
> #### Input Parameters
>
> **status** `string ("active" | "paused")`
>
> New operating status for the inbox.
>
> **inbox\_id** `string` *required*
>
> ID of the AgentMail inbox, typically its full email address.
>
> **metadata** `object`
>
> Metadata to merge, or null to clear all metadata. Set a key to null to remove it.
>
> **display\_name** `string`
>
> New display name for the inbox.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Inbox Webhook
>
> **Slug:** `AGENT_MAIL_UPDATE_INBOX_WEBHOOK`
>
> Update an inbox-scoped regular webhook's enabled state or replace its event types. An empty update is allowed. The response contains a credential-sensitive signature secret; never log or expose it.
>
> #### Input Parameters
>
> **enabled** `boolean`
>
> Enable or disable delivery; omit to leave unchanged. Re-enabling checks the additional read permissions required by restricted event\_types.
>
> **inbox\_id** `string` *required*
>
> ID of the inbox that owns the webhook.
>
> **webhook\_id** `string` *required*
>
> ID of the webhook to update.
>
> **event\_types** `array`
>
> Complete non-empty replacement for subscribed event types. Omit to leave them unchanged; this is not a merge. Restricted spam, blocked, unauthenticated, security, and calendar events require their matching label, message, or calendar read permission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Inbox Webhook Headers
>
> **Slug:** `AGENT_MAIL_UPDATE_INBOX_WEBHOOK_HEADERS`
>
> Atomically set, replace, or remove custom delivery headers on an inbox-scoped regular webhook. At least one real header change is required. Header values are credential-sensitive and write-only; never log or expose them.
>
> #### Input Parameters
>
> **headers** `object`
>
> Non-empty map of custom headers to set or replace. Values are credential-sensitive and write-only; never log or expose them.
>
> **inbox\_id** `string` *required*
>
> ID of the inbox that owns the webhook.
>
> **webhook\_id** `string` *required*
>
> ID of the webhook whose custom headers to update.
>
> **remove\_headers** `array`
>
> Custom header names to remove; may be empty when headers has changes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Message Labels
>
> **Slug:** `AGENT_MAIL_UPDATE_MESSAGE_LABELS`
>
> Add or remove labels from one message in an inbox. Source or target records with spam, blocked, unauthenticated, or trash labels may be hidden or reported not found when the API key lacks the corresponding label visibility permission.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox containing the message, usually its full email address.
>
> **add\_labels** `array`
>
> Labels to add to the message.
>
> **message\_id** `string` *required*
>
> ID of the message to update.
>
> **remove\_labels** `array`
>
> Labels to remove from the message.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Pod Inbox
>
> **Slug:** `AGENT_MAIL_UPDATE_POD_INBOX`
>
> Update the display name, active or paused status, or metadata of an inbox inside an explicitly selected AgentMail pod. Provide at least one field.
>
> #### Input Parameters
>
> **pod\_id** `string` *required*
>
> ID of the pod that owns the inbox.
>
> **status** `string ("active" | "paused")`
>
> Set paused to stop sending and silently drop incoming mail without bounce or later delivery; set active to resume new mail.
>
> **inbox\_id** `string` *required*
>
> ID of the inbox to update.
>
> **metadata** `object`
>
> Metadata keys to merge. Omitted keys remain unchanged, a per-key null removes that key, and metadata null clears all metadata. Omit the field to leave metadata unchanged; an empty object is rejected.
>
> **display\_name** `string`
>
> New inbox display name. Omit to leave it unchanged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Thread Labels
>
> **Slug:** `AGENT_MAIL_UPDATE_THREAD_LABELS`
>
> Add or remove custom labels from every message in one thread. Source or target records with spam, blocked, unauthenticated, or trash labels may be hidden or reported not found when the API key lacks the corresponding label visibility permission.
>
> #### Input Parameters
>
> **thread\_id** `string` *required*
>
> Thread ID to update.
>
> **add\_labels** `array`
>
> Custom labels to add. System labels are not allowed.
>
> **remove\_labels** `array`
>
> Custom labels to remove. System labels are not allowed; removal wins when a label is also present in add\_labels.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Webhook
>
> **Slug:** `AGENT_MAIL_UPDATE_WEBHOOK`
>
> Update an organization-level webhook's enabled state, event types, or inbox and pod subscriptions. An empty update is allowed. The response contains a credential-sensitive signature secret; never log or expose it.
>
> #### Input Parameters
>
> **enabled** `boolean`
>
> Enable or disable delivery; omit to leave unchanged. Re-enabling checks the additional read permissions required by restricted event\_types.
>
> **webhook\_id** `string` *required*
>
> ID of the webhook to update.
>
> **add\_pod\_ids** `array`
>
> Pod IDs to add without replacing existing subscriptions.
>
> **event\_types** `array`
>
> Complete non-empty replacement for subscribed event types. Omit to leave them unchanged; this is not a merge. Restricted spam, blocked, unauthenticated, security, and calendar events require their matching label, message, or calendar read permission.
>
> **add\_inbox\_ids** `array`
>
> Inbox IDs to add without replacing existing subscriptions.
>
> **remove\_pod\_ids** `array`
>
> Pod IDs to remove from the subscription.
>
> **remove\_inbox\_ids** `array`
>
> Inbox IDs to remove from the subscription.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Webhook Headers
>
> **Slug:** `AGENT_MAIL_UPDATE_WEBHOOK_HEADERS`
>
> Atomically set, replace, or remove custom delivery headers on an organization-level webhook. At least one real header change is required. Header values are credential-sensitive and write-only; never log or expose them.
>
> #### Input Parameters
>
> **headers** `object`
>
> Non-empty map of custom headers to set or replace. Values are credential-sensitive and write-only; never log or expose them.
>
> **webhook\_id** `string` *required*
>
> ID of the webhook whose headers to update.
>
> **remove\_headers** `array`
>
> Custom header names to remove; may be empty when headers has changes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

## Triggers

> [accordion] New Email Received
>
> **Slug:** `AGENT_MAIL_NEW_EMAIL_TRIGGER`
>
> **Type:** poll
>
> Trigger for new emails in an AgentMail inbox
>
> #### Configuration
>
> **inbox\_id** `string` *required*
>
> The inbox ID or email address to monitor for new emails
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **labels** `array`
>
> Filter messages by specific labels (e.g., 'unread', 'inbox')
>
> #### Payload
>
> **attachments** `array`
>
> Message attachments
>
> **bcc** `array`
>
> BCC email addresses
>
> **cc** `array`
>
> CC email addresses
>
> **created\_at** `string` *required*
>
> When the message was created
>
> **from** `string` *required*
>
> Sender's email address
>
> **html** `string`
>
> HTML content
>
> **in\_reply\_to** `string`
>
> ID of message being replied to
>
> **inbox\_id** `string` *required*
>
> ID of the inbox
>
> **labels** `array` *required*
>
> Labels applied to the message
>
> **message\_id** `string` *required*
>
> ID of the message
>
> **preview** `string`
>
> Text preview of the message
>
> **references** `array`
>
> IDs of previous messages in thread
>
> **reply\_to** `array`
>
> Reply-to email addresses
>
> **subject** `string`
>
> Email subject
>
> **text** `string`
>
> Plain text content
>
> **thread\_id** `string` *required*
>
> ID of the thread
>
> **timestamp** `string` *required*
>
> When the message was received
>
> **to** `array` *required*
>
> Recipient email addresses
>
> **updated\_at** `string` *required*
>
> When the message was last updated
