Skip to main content
Agent Mail logo
  • Category: email
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 93
  • Triggers: 1
  • Slug: AGENT_MAIL
  • Version: 20261101_00

Tools

Slug: AGENT_MAIL_BATCH_GET_MESSAGESReturn 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

string
required
ID of the inbox containing all requested messages.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_BATCH_UPDATE_MESSAGE_LABELSAtomically 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

string
required
Inbox ID containing all target messages, usually its full email address.
array
Labels to add to every resolved message.
array
required
Unique message IDs to update (up to 50), all from the specified inbox.
array
Labels to remove from every resolved message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_COMPLETE_FILE_UPLOADMark 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

string
required
ID returned by CREATE_FILE.
string
required
Inbox that owns the pending file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_AGENT_ARMOR_FEEDBACKRecord whether Agent Armor’s completed verdict on a message was correct. A message accepts up to 20 feedback records.

Input Parameters

string
Additional context about the verdict.
string ("correct_review" | "incorrect_review" | "missed_threat" | "legitimate_agent_instruction" | "spam_or_phishing")
required
Assessment of Agent Armor’s completed verdict.
string
required
ID of the inbox containing the assessed message.
string
required
ID of the message whose verdict is being assessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_CALENDAR_EVENTCreate 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

string
required
Local wall-clock end in the event time zone.
string
required
Local wall-clock start in the event time zone.
string
required
Event title.
string ("confirmed" | "tentative" | "cancelled")
Initial status; defaults to confirmed.
boolean
Use date-only boundaries; defaults to false.
string
required
Inbox whose calendar will own the event.
string
Event location.
string
Caller-owned JSON metadata, up to 16,384 bytes.
string
IANA time zone; defaults to the calendar time zone.
array
Event attendees.
string
Stable create idempotency key for safe retries.
object
RFC 5545 recurrence definition.
string
Description, up to 65,536 UTF-8 bytes.
boolean
Email every attendee an invitation; defaults to false.
string ("nominal" | "exact")
Duration behavior across daylight-saving transitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_DRAFTCreate a draft, optionally scheduling its automatic delivery with send_at.

Input Parameters

array
CC recipient addresses
array
Recipient addresses
array
BCC recipient addresses
string
HTML body of the draft
string
Plain-text body of the draft
array
Labels to apply to the draft
string
Future time at which AgentMail should automatically send the draft
string
Subject of the draft
string
required
ID of the AgentMail inbox, typically its full email address
array
Reply-to addresses for the draft
string
Client-provided identifier for the draft
boolean
Whether to address all recipients of the replied-to message
string
Message ID to create this draft as a forward of
array
Attachments to include in the draft
string
Message ID to create this draft as a reply to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_FILEInitialize 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

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.
integer
required
Exact file size in bytes, up to 100 MiB.
string
required
Base64 encoding of the file’s 32-byte SHA-256 digest: exactly 44 characters ending in ’=’.
string
required
Inbox whose drive will contain the file.
string
Future ISO 8601 expiry time. On a retry, send the expires_at returned by the first response.
string
MIME type; omit to use application/octet-stream.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_INBOXCreate 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

string
Domain for the inbox email address. Must be a verified domain in your AgentMail account. Defaults to ‘agentmail.to’ if not provided.
string
Username for the inbox. Used to create the email address (username@domain). If not provided, a random username will be generated.
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.
string
Display name for the inbox (shown as the sender name in emails)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_INBOX_API_KEYCreate an inbox-scoped bearer key and return its one-time secret. Permissions can be specified to restrict the key.

Input Parameters

string
Human-readable name for the new API key
string
required
Inbox identifier, typically its full email address
string
Future expiration time in ISO 8601 format. Omit to inherit the authenticating key’s expiration
object
Permissions granted to the key. Omit to grant all permissions; when provided, only fields set to true are granted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_INBOX_IN_PODCreate an inbox inside an explicitly selected AgentMail pod, optionally choosing its address, initial status, idempotency ID, and metadata.

Input Parameters

string
Verified address domain; omit to use agentmail.to.
string
required
ID of the pod in which to create the inbox.
string ("active" | "paused")
Initial inbox status. Paused stops sending and silently drops incoming mail without bouncing or queueing it for delivery after resume.
object
Custom string, number, or boolean metadata. Up to 256 entries; keys and string values are limited to 256 characters.
string
Username portion of the inbox address; omit to generate one.
string
Caller-provided correlation or idempotency ID.
string
Display name used when the inbox sends email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_INBOX_POLLING_WEBHOOKCreate 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

string
required
Inbox whose events this polling webhook queues.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_INBOX_WEBHOOKCreate 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

string
required
HTTP or HTTPS endpoint that receives webhook deliveries.
object
Custom delivery headers. Values are credential-sensitive and write-only: AgentMail never returns them. Never log or expose header values.
string
required
ID of the inbox that will own the webhook.
string
Caller-provided ID for the webhook.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_LIST_ENTRYAdd an email address or domain to an organization-wide send, receive, or reply allowlist or blocklist.

Input Parameters

string
required
Email address or domain to add.
string
Reason for adding the entry.
string ("send" | "receive" | "reply")
required
Mail direction governed by the list.
string ("allow" | "block")
required
Whether to add to the allowlist or blocklist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_PODCreate an AgentMail pod for grouping inboxes and related resources.

Input Parameters

string
Human-readable name for the pod.
string
Caller-provided idempotency identifier for safe retries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_POLLING_WEBHOOKCreate 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

array
Pod IDs whose events should be delivered. A listed pod already covers all of its inboxes.
string
required
Required idempotency key for this consumer. Reusing it returns the same subscription with a new token and immediately invalidates the old token.
array
Inbox IDs whose events should be delivered to the webhook.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_CREATE_WEBHOOKCreate 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

string
required
HTTP or HTTPS endpoint that receives webhook deliveries.
object
Custom delivery headers. Values are credential-sensitive and write-only: AgentMail never returns them. Never log or expose header values.
array
Pod IDs whose events should be delivered. A listed pod already covers all of its inboxes.
string
Caller-provided ID for the webhook.
array
Inbox IDs whose events should be delivered to the webhook.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_CALENDAR_EVENTAccept 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

string ("single" | "future")
For a dated ID, cancel one date or it and all later dates.
string
required
Event UUID or stable dated instance ID.
string
Current event ETag, or *, for a conditional delete.
string
required
Inbox that owns the event.
boolean
Email every attendee a cancellation; defaults to false.
string
Visible-ASCII retry key unique across the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_DRAFTPermanently delete one unsent draft from an inbox.

Input Parameters

string
required
Draft ID to permanently delete.
string
required
Inbox that owns the draft.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_FILEPermanently 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

string
required
ID of the file to permanently delete.
string
required
Inbox that owns the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_INBOXPermanently delete one inbox by ID. AgentMail accepts the deletion asynchronously, so acceptance does not guarantee immediate completion.

Input Parameters

string
required
Inbox ID to permanently delete, usually its full email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_INBOX_POLLING_WEBHOOKPermanently 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

string
required
Inbox that owns the polling webhook.
string
required
Polling webhook identifier. AgentMail accepts either its webhook_id or its caller-provided client_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_INBOX_WEBHOOKPermanently delete a regular webhook created for a selected AgentMail inbox and stop future deliveries.

Input Parameters

string
required
ID of the inbox that owns the webhook.
string
required
ID of the webhook to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_LIST_ENTRYRemove one email address or domain from an organization-wide send, receive, or reply allowlist or blocklist.

Input Parameters

string
required
Exact email address or domain to remove.
string ("send" | "receive" | "reply")
required
Mail direction governed by the list.
string ("allow" | "block")
required
Whether to remove from the allowlist or blocklist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_MESSAGEPermanently 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

string
required
Inbox containing the message.
string
required
Message ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_PODPermanently delete one AgentMail pod by its unique ID.

Input Parameters

string
required
Unique ID of the pod to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_POD_INBOXPermanently 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

string
required
ID of the pod that owns the inbox.
string
required
ID of the inbox to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_POLLING_WEBHOOKPermanently 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

string
required
Polling webhook identifier. AgentMail accepts either its webhook_id or its caller-provided client_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_THREADPermanently delete one AgentMail thread and all of its messages.

Input Parameters

string
required
ID of the inbox containing the thread. Use AGENT_MAIL_LIST_INBOXES to discover inbox IDs.
string
required
ID of the thread to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_DELETE_WEBHOOKPermanently delete an organization-level webhook and stop future deliveries.

Input Parameters

string
required
ID of the webhook to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_FORWARD_MESSAGEImmediately 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

array
Cc recipient address or addresses.
array
Primary recipient addresses for the forwarded message. Omit when the forward is addressed only with cc or bcc.
array
Bcc recipient address or addresses.
string
HTML content to add above the forwarded message.
string
Plain-text content to add above the forwarded message.
array
Labels to apply to the forwarded message.
object
Additional outbound message headers.
string
Subject for the forwarded message; omit to use the generated subject.
string
required
Inbox containing the message to forward.
array
Reply-To address or addresses.
string
required
ID of the message to forward.
array
Additional attachments to include with the forwarded message.
boolean
Whether to track the first open when the account and HTML body support it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_AGENDAGet 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

string
Window start as a UTC timestamp ending in Z.
integer
Maximum agenda items; defaults to 50.
string
Window end as a UTC timestamp ending in Z.
string
required
Inbox whose expanded agenda to retrieve.
string
Continuation token from a previous call; omit for the first page.
string ("eventual" | "primary")
Use primary to read completed writes immediately.
boolean
Include events already running at after; AgentMail defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_API_KEYRetrieve API-key metadata without exposing bearer secret values.

Input Parameters

string
required
API-key ID, or client_id alias for a public-key credential

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_CALENDARGet an inbox’s US-only calendar settings, event count, and ETag. Use primary consistency to read a just-completed write.

Input Parameters

string
required
Inbox whose calendar to retrieve.
string ("eventual" | "primary")
Use primary to read completed writes immediately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_CALENDAR_EVENTGet the full current form of a US-only calendar event or recurring-event date, including its opaque ETag for conditional mutations.

Input Parameters

string
required
Event UUID or stable dated instance ID.
string
required
Inbox that owns the event.
string ("eventual" | "primary")
Use primary to read completed writes immediately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_CURRENT_IDENTITYReturn the connected AgentMail identity and its organization, pod, or inbox access boundary without exposing the credential itself.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_DOMAINReturn an AgentMail custom domain, its domain and tracking verification statuses, and all required DNS records.

Input Parameters

string
required
AgentMail domain ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_DOMAIN_ZONE_FILEDownload the AgentMail-generated DNS zone file for a custom domain as a bounded binary file reference.

Input Parameters

string
required
AgentMail domain ID whose DNS zone file to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_DRAFTRetrieve the complete contents and scheduling details of one draft.

Input Parameters

string
required
ID of the draft to retrieve
string
required
ID of the AgentMail inbox containing the draft

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_DRAFT_ATTACHMENTGet a temporary download reference for one draft attachment.

Input Parameters

string
required
Draft containing the attachment.
string
required
Attachment ID returned by the draft read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_FILEGet 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

string
required
ID of the file to retrieve.
string
required
Inbox that owns the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_INBOXRetrieve one AgentMail inbox and its metadata by ID or email address.

Input Parameters

string
required
Inbox ID or email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_INBOX_POLLING_WEBHOOKGet 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

string
required
Inbox that owns the polling webhook.
string
required
Polling webhook identifier. AgentMail accepts either its webhook_id or its caller-provided client_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_INBOX_WEBHOOKGet one regular webhook created for a selected AgentMail inbox. The response contains a credential-sensitive signature secret; never log or expose it.

Input Parameters

string
required
ID of the inbox that owns the webhook.
string
required
ID of the webhook to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_INBOX_WEBHOOK_HEADERSList 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

string
required
ID of the inbox that owns the webhook.
string
required
ID of the webhook whose custom header names to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_MESSAGERetrieve 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

string
required
MUST be a valid email address (e.g., agent@agentmail.to). This is NOT an ID or identifier - it must be a full email address of the inbox.
string
required
The unique message identifier (NOT an email address). Get this from the ‘message_id’ field returned by LIST_MESSAGES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_MESSAGE_ATTACHMENTGet 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

string
required
Inbox containing the message.
string
required
Message containing the attachment.
string
required
Attachment ID returned by the message read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_ORGANIZATIONReturn the connected AgentMail organization’s identifiers, current inbox and domain counts, configured resource limits, and timestamps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_PODRetrieve one AgentMail pod by its unique ID.

Input Parameters

string
required
Unique ID of the pod to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_POD_INBOXGet an AgentMail inbox through an explicitly selected pod, preserving the pod tenant boundary.

Input Parameters

string
required
ID of the pod that must own the inbox.
string
required
ID of the inbox to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_POLLING_WEBHOOKGet 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

string
required
Polling webhook identifier. AgentMail accepts either its webhook_id or its caller-provided client_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_RAW_MESSAGEGet 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

string
required
ID of the inbox containing the message, usually its full email address.
string
required
ID of the message whose raw RFC 5322 source to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_THREADRetrieve one AgentMail thread and a paginated page of its messages.

Input Parameters

integer
Maximum number of messages to return in this page (1-100).
string
required
ID of the inbox containing the thread. Use AGENT_MAIL_LIST_INBOXES to discover inbox IDs.
string
required
The thread ID to retrieve.
string
Token from a previous response for retrieving the next, older page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_THREAD_ATTACHMENTGet 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

string
required
Thread containing the attachment.
string
required
Attachment ID returned by a thread or message read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_WEBHOOKGet one organization-level webhook configuration by ID. The response contains a credential-sensitive signature secret; never log or expose it.

Input Parameters

string
required
ID of the webhook to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_GET_WEBHOOK_HEADERSList only the names of custom delivery headers on an organization-level webhook. Header values are credential-sensitive, write-only, and never returned.

Input Parameters

string
required
ID of the webhook whose headers to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_CALENDAR_EVENT_INSTANCESList 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

string
Window start as a UTC timestamp ending in Z.
integer
Maximum dates to return; defaults to 50.
string
Window end as a UTC timestamp ending in Z.
string
required
UUID of the recurring event.
string
required
Inbox that owns the recurring event.
string
Continuation token from a previous call; omit for the first page.
string ("eventual" | "primary")
Use primary to read completed writes immediately.
boolean
Include dates already running at after; defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_CALENDAR_EVENTSList 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

integer
Maximum events to return; defaults to 50.
string
required
Inbox whose stored calendar events to list.
string
Continuation token from a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_DOMAINSList one page of AgentMail custom domains and return the continuation token for the next page.

Input Parameters

integer
Maximum number of domains to return on this page.
boolean
Sort in ascending creation-time order when true.
string
Continuation token from a previous response’s next_page_token; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_DRAFTSList unsent drafts in an AgentMail inbox with filters and pagination.

Input Parameters

string
Return drafts updated after this ISO 8601 timestamp
integer
Maximum number of drafts to return
string
Return drafts updated before this ISO 8601 timestamp
array
Return drafts having these labels
string
required
ID of the AgentMail inbox, typically its full email address
boolean
Sort drafts in ascending temporal order when true
string
Token returned by a previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_FILESList 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

integer
Page size, 100 by default and at most 500.
string
required
Inbox whose drive files to list.
boolean
Sort paths ascending when true (the default), or descending when false.
string
Opaque continuation token from this action’s previous response. It retains the inbox and filter context; omit other parameters when continuing.
string
Return only files whose path starts with this character prefix; it need not end at a path-segment boundary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_INBOX_API_KEYSList API-key metadata scoped to an inbox without exposing secret values.

Input Parameters

integer
Maximum number of API-key records to return
string
required
ID of the inbox whose API-key metadata should be listed
string
Token returned by a previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_INBOXESList 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

integer
Maximum number of inboxes to return per page
boolean
Sort inboxes in ascending order by created_at timestamp (oldest first). Default is descending (newest first)
string
Token for pagination to get the next set of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_INBOX_EVENTSList label-change events from an AgentMail inbox.

Input Parameters

integer
Maximum number of events to return
string
required
ID of the AgentMail inbox, typically its full email address
boolean
Sort events in ascending temporal order when true
string
Token returned by a previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_INBOX_POLLING_WEBHOOKSList 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

integer
Maximum number of polling webhooks to return on this page.
string
required
Inbox whose polling webhooks to list.
boolean
Return polling webhooks in ascending creation-time order (oldest first).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_INBOX_WEBHOOKSList one page of regular webhooks created for a selected AgentMail inbox. Responses contain credential-sensitive signature secrets; never log or expose them.

Input Parameters

integer
Maximum number of webhooks to return on this page.
string
required
ID of the inbox whose webhooks to list.
boolean
Return webhooks in ascending creation-time order (oldest first).
string
Opaque continuation token from this action’s previous response. It retains the inbox and list options; omit other parameters when continuing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_LIST_ENTRIESList 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

string
Exact email address or domain to retrieve; omit to list entries.
integer
Maximum number of entries to return on this page.
string ("send" | "receive" | "reply")
required
Mail direction governed by the list.
string ("allow" | "block")
required
Whether to inspect the allowlist or blocklist.
string
Opaque continuation token from a previous list call. Omit for the first page; ignored when entry is supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_MESSAGESList messages from an AgentMail inbox. Returns a messages array; each message uses message_id and timestamp fields (not id, date, or items).

Input Parameters

string
Return messages sent after this timestamp (ISO 8601 format)
integer
Maximum number of messages to return (1-100)
string
Return messages sent before this timestamp (ISO 8601 format)
array
Filter messages by labels (e.g., ‘sent’, ‘unread’, ‘important’)
string
required
MUST be a valid email address (e.g., agent@agentmail.to). This is NOT an ID or identifier - it must be a full email address of the inbox.
boolean
Sort messages in ascending order by timestamp (oldest first). Default is descending (newest first)
string
Token for pagination to get the next set of results
boolean
Include messages marked as spam in the results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_POD_INBOXESList 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

integer
Maximum number of inboxes to return on this page.
string
Address or display-name text to search by word prefix. Omit for a chronological list.
string
required
ID of the pod whose inboxes should be listed or searched.
boolean
Return oldest inboxes first when listing.
string
Opaque continuation token from a previous call. It retains the pod and list or search context; omit other parameters when continuing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_PODSReturn one page of AgentMail pods and its continuation token.

Input Parameters

integer
Maximum number of pods to return on this page.
boolean
Return pods from oldest to newest by creation time when true.
string
Continuation token from a previous call. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_POLLING_WEBHOOKSList 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

integer
Maximum number of polling webhooks to return on this page.
boolean
Return polling webhooks in ascending creation-time order (oldest first).
string
Opaque continuation token from this action’s previous response. Tokens from other list endpoints are rejected. Omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_THREADSList conversation threads in an AgentMail inbox with filters.

Input Parameters

string
Return threads after this ISO 8601 timestamp.
integer
Maximum number of threads to return (1-100).
string
Return threads before this ISO 8601 timestamp.
array
Labels that threads must match.
array
Sender substrings that must all match. Repeatable.
array
Subject substrings that must all match. Repeatable.
string
required
ID of the inbox whose threads should be listed. Use AGENT_MAIL_LIST_INBOXES to discover inbox IDs.
boolean
Sort in ascending temporal order.
string
Token returned by a previous page.
array
Recipient substrings that must all match. Repeatable.
boolean
Include spam threads.
boolean
Include trashed threads.
boolean
Include blocked threads.
boolean
Include unauthenticated threads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_LIST_WEBHOOKSList AgentMail webhook configurations.

Input Parameters

integer
Maximum number of webhooks to return
boolean
Sort webhooks in ascending creation order when true
string
Token returned by a previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_QUERY_INBOX_EVENT_METRICSQuery timestamped email-event counts for an AgentMail inbox.

Input Parameters

string
End of the query range as an ISO 8601 timestamp.
integer
Maximum number of metric buckets to return.
string
Start of the query range as an ISO 8601 timestamp within the last 90 days.
integer
Size of each aggregate time bucket in seconds (1-86400). Omit for individual event counts.
string
required
Email address identifying the AgentMail inbox.
boolean
Whether to return buckets in descending timestamp order.
array
Event types to include. Each value is sent as a repeated query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_QUERY_METRICSQuery organization-wide email event counts or cumulative resource-usage time series over a bounded time range.

Input Parameters

string
Exclusive end timestamp; future values are clamped to the current time.
integer
Maximum number of points to return in each metric series.
string
Inclusive start timestamp, which must be within the last 90 days; defaults to 24 hours ago.
integer
Time-bucket size in whole seconds from 1 to 86400; omit for individual event counts.
boolean
Return metric points from newest to oldest.
array
Event series to return for events metrics; omit to return every type.
string ("events" | "usage")
required
Query email and domain event counts or cumulative resource usage.
array
Usage series to return for usage metrics; omit to return every type valid at organization scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_QUERY_RATE_METRICSQuery organization-wide rolling bounce and complaint rates.

Input Parameters

string
End of the query range as an ISO 8601 timestamp.
integer
Maximum number of metric buckets to return.
string
Start of the query range as an ISO 8601 timestamp within the last 90 days.
integer
Size of each sampling period in seconds (60-86400).
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.
boolean
Whether to return buckets in descending timestamp order.
array
Rate series to include. Each value is sent as a repeated query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_RELEASE_HELD_MESSAGERelease 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

string
required
Why the message is safe to release; must not be blank.
string
required
ID of the inbox containing the held message.
string
required
ID of the held message to release.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_REPLY_TO_MESSAGEReply to a selected message while preserving its AgentMail thread.

Input Parameters

string
CC recipient addresses
string
Recipient addresses overriding the default recipient
string
BCC recipient addresses
string
HTML body of the reply
string
Plain-text body of the reply
array
Labels to apply to the reply
object
Additional headers to include in the reply
string
required
ID of the AgentMail inbox containing the original message
string
Reply-to addresses for the reply
boolean
Whether to reply to all recipients of the original message
string
required
ID of the message to reply to
array
Attachments to include in the reply. Each attachment must provide base64 content or a downloadable url.
boolean
Whether to track the first open; requires tracking and an HTML body

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_RESPOND_TO_CALENDAR_EVENTAccept, 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

string ("accepted" | "declined" | "tentative")
required
Inbox’s response to the invitation.
string
Response comment, up to 4,096 UTF-8 bytes.
string
required
Event UUID or dated instance ID to respond to.
string
Current event ETag, or *, for a conditional response.
string
required
Invited inbox responding to the event.
boolean
Email the organizer; AgentMail defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_SEND_DRAFTImmediately send and consume a draft, optionally changing message labels.

Input Parameters

string
required
ID of the draft to send
string
required
ID of the AgentMail inbox containing the draft
string
Labels to add to the resulting sent message
string
Labels to remove from the resulting sent message

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_SEND_EMAILSend an email using AgentMail API

Input Parameters

array
List of CC recipient email addresses
array
required
List of recipient email addresses
array
List of BCC recipient email addresses
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.
string
Plain text content of the email. Either text or html (or both) must be provided.
array
Labels to apply to the sent message
string
required
Email subject line
string
required
The inbox identifier (typically the full email address, e.g., ‘your-inbox@agentmail.to’). Use AGENT_MAIL_LIST_INBOXES to discover available inbox IDs, or AGENT_MAIL_CREATE_INBOX to create a new inbox.
array
Reply-to email addresses

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_SEND_MESSAGEImmediately 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

array
Cc recipient address or addresses.
array
Primary recipient address or addresses. Each may be an email address or a display-name address such as ‘Ada <ada@example.com>’; AgentMail also accepts messages addressed only with cc or bcc.
array
Bcc recipient address or addresses.
string
HTML body, when provided.
string
Plain-text body, when provided.
array
Labels to apply to the sent message.
object
Additional outbound email headers.
string
Email subject, when provided.
string
required
ID of the inbox to send from, usually its full email address.
array
Reply-To address or addresses.
array
Attachments supplied as base64 content or public/pre-signed URLs.
boolean
Track the first open. Requires an HTML body and a verified custom domain with open tracking enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_UPDATE_CALENDARChange 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

string
Current calendar ETag, or *, for a conditional update.
string
required
Inbox whose calendar to update.
string
required
New default IANA time zone for subsequently created events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_UPDATE_CALENDAR_EVENTPatch 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

string
Replacement local wall-clock end.
string ("single" | "future")
For a dated ID, change one date or it and all later dates.
string
Replacement local wall-clock start.
string
Replacement title.
string ("confirmed" | "tentative" | "cancelled")
Replacement event status.
boolean
Replacement all-day setting.
string
required
Event UUID or stable dated instance ID.
string
Current event ETag, or *, for a conditional update.
string
required
Inbox that owns the event.
string
Replacement location; null clears it.
string
Replacement JSON metadata; null clears it.
string
Replacement IANA time zone.
array
Replacement attendee list.
object
Replacement recurrence; null turns an eligible series into one-off.
string
Replacement description; null clears it.
boolean
Email the updated invitation to every attendee.
string ("nominal" | "exact")
Replacement duration behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_UPDATE_DRAFTEdit a draft, reschedule delivery, or cancel a scheduled send with null.

Input Parameters

array
CC recipient addresses; pass null or an empty list to clear them
array
Recipient addresses; pass null or an empty list to clear them
array
BCC recipient addresses; pass null or an empty list to clear them
string
HTML body; pass null to clear it
string
Plain-text body; pass null to clear it
string
Future automatic-send time; pass null to cancel a scheduled send
string
Subject of the draft; pass null to clear it
string
required
ID of the draft to update
string
required
ID of the AgentMail inbox, typically its full email address
array
Reply-to addresses; pass null or an empty list to clear them
array
Labels to add to the draft
array
Labels to remove from the draft
array
Attachments to add to the draft
array
IDs of attachments to remove from the draft

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_UPDATE_INBOXUpdate an inbox’s display name, status, or custom metadata.

Input Parameters

string ("active" | "paused")
New operating status for the inbox.
string
required
ID of the AgentMail inbox, typically its full email address.
object
Metadata to merge, or null to clear all metadata. Set a key to null to remove it.
string
New display name for the inbox.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_UPDATE_INBOX_WEBHOOKUpdate 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

boolean
Enable or disable delivery; omit to leave unchanged. Re-enabling checks the additional read permissions required by restricted event_types.
string
required
ID of the inbox that owns the webhook.
string
required
ID of the webhook to update.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_UPDATE_INBOX_WEBHOOK_HEADERSAtomically 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

object
Non-empty map of custom headers to set or replace. Values are credential-sensitive and write-only; never log or expose them.
string
required
ID of the inbox that owns the webhook.
string
required
ID of the webhook whose custom headers to update.
array
Custom header names to remove; may be empty when headers has changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_UPDATE_MESSAGE_LABELSAdd 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

string
required
Inbox containing the message, usually its full email address.
array
Labels to add to the message.
string
required
ID of the message to update.
array
Labels to remove from the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_UPDATE_POD_INBOXUpdate 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

string
required
ID of the pod that owns the inbox.
string ("active" | "paused")
Set paused to stop sending and silently drop incoming mail without bounce or later delivery; set active to resume new mail.
string
required
ID of the inbox to update.
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.
string
New inbox display name. Omit to leave it unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_UPDATE_THREAD_LABELSAdd 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

string
required
Thread ID to update.
array
Custom labels to add. System labels are not allowed.
array
Custom labels to remove. System labels are not allowed; removal wins when a label is also present in add_labels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_UPDATE_WEBHOOKUpdate 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

boolean
Enable or disable delivery; omit to leave unchanged. Re-enabling checks the additional read permissions required by restricted event_types.
string
required
ID of the webhook to update.
array
Pod IDs to add without replacing existing subscriptions.
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.
array
Inbox IDs to add without replacing existing subscriptions.
array
Pod IDs to remove from the subscription.
array
Inbox IDs to remove from the subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENT_MAIL_UPDATE_WEBHOOK_HEADERSAtomically 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

object
Non-empty map of custom headers to set or replace. Values are credential-sensitive and write-only; never log or expose them.
string
required
ID of the webhook whose headers to update.
array
Custom header names to remove; may be empty when headers has changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: AGENT_MAIL_NEW_EMAIL_TRIGGERType: pollTrigger for new emails in an AgentMail inbox

Configuration

string
required
The inbox ID or email address to monitor for new emails
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
array
Filter messages by specific labels (e.g., ‘unread’, ‘inbox’)

Payload

array
Message attachments
array
BCC email addresses
array
CC email addresses
string
required
When the message was created
string
required
Sender’s email address
string
HTML content
string
ID of message being replied to
string
required
ID of the inbox
array
required
Labels applied to the message
string
required
ID of the message
string
Text preview of the message
array
IDs of previous messages in thread
array
Reply-to email addresses
string
Email subject
string
Plain text content
string
required
ID of the thread
string
required
When the message was received
array
required
Recipient email addresses
string
required
When the message was last updated