12 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.
Read Gmail attachment
gmail.attachmentread
Download one attachment, up to 10 MB, from a message in the chosen Gmail account. Returns standard base64 bytes, filename and MIME type; sends no messages and makes no public file.
Parameters
Field
Type
Required
Description
connectionId
string (uuid)
required
ID of the Gmail account shared with this workspace. Determines the actual sending or reading account.
messageId
string
required
Google's message ID, returned by Gmail search, read or incoming-mail events.
partId
string
required
MIME partId from the message's attachments array, including an empty string for a root attachment.
Over MCP the same operation is the tool gmail_attachment at https://app.chirply.io/api/mcp, same bearer token, same input.
Connect Gmail
gmail.connectreadadmin only
Get an account-bound browser link to connect another Gmail account. A manager must sign in and consent in Google to share reading and sending access with account members and authorized integrations. This call sends no email.
Over MCP the same operation is the tool gmail_connect at https://app.chirply.io/api/mcp, same bearer token, same input.
Gmail accounts
gmail.connectionsread
List Gmail accounts explicitly shared with this account, their connecting user and reconnect status. Does not expose tokens, read mailbox contents or send mail.
Over MCP the same operation is the tool gmail_deliveries at https://app.chirply.io/api/mcp, same bearer token, same input.
Disconnect Gmail
gmail.disconnectwriteconfirmadmin only
Remove the saved Gmail authorization from this account and stop its sync and sending. Retains already imported Conversations and delivery receipts; does not delete anything in Google or revoke Calendar/Sheets grants.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Parameters
Field
Type
Required
Description
connectionId
string (uuid)
required
ID of the Gmail account shared with this workspace. Determines the actual sending or reading account.
Over MCP the same operation is the tool gmail_disconnect at https://app.chirply.io/api/mcp, same bearer token, same input.
Import Gmail history
gmail.import_historywriteadmin only
Import one page of historical incoming Gmail mail into Conversations. Only mail older than the initial connection is imported. Historical mail never emits incoming-mail automation triggers. Returns nextPageToken for continuing the import; sends no email itself.
Parameters
Field
Type
Required
Description
connectionId
string (uuid)
required
ID of the Gmail account shared with this workspace. Determines the actual sending or reading account.
query
string
optional
Native Gmail search, such as from:customer@example.com has:attachment newer_than:7d. Default: "in:inbox"
pageToken
string
optional
Opaque nextPageToken from the preceding page; omit for the first page.
limit
integer
optional
Maximum messages to return on this page, from 1 to 50. Default: 20
Over MCP the same operation is the tool gmail_import_history at https://app.chirply.io/api/mcp, same bearer token, same input.
Read Gmail message
gmail.read_messageread
Read one Gmail message's sender, recipients, subject, plain text, HTML and attachment references from the chosen account account. Does not alter Gmail read status or send mail.
Parameters
Field
Type
Required
Description
connectionId
string (uuid)
required
ID of the Gmail account shared with this workspace. Determines the actual sending or reading account.
messageId
string
required
Google's message ID, returned by Gmail search, read or incoming-mail events.
Over MCP the same operation is the tool gmail_read_message at https://app.chirply.io/api/mcp, same bearer token, same input.
Read Gmail thread
gmail.read_threadread
Read all messages in a thread from the selected Gmail account, including Sent messages and attachment references. Does not modify the mailbox or send mail.
Parameters
Field
Type
Required
Description
connectionId
string (uuid)
required
ID of the Gmail account shared with this workspace. Determines the actual sending or reading account.
threadId
string
required
Google thread ID returned by a message, search or send.
Over MCP the same operation is the tool gmail_read_thread at https://app.chirply.io/api/mcp, same bearer token, same input.
Reply through Gmail
gmail.replywriteconfirm
Send a real reply through the selected Gmail account to the original sender or Reply-To address. Preserves Gmail thread ID, original subject and RFC reply headers. Appears in Gmail Sent; opt-outs and Google sending limits apply.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Parameters
Field
Type
Required
Description
connectionId
string (uuid)
required
ID of the Gmail account shared with this workspace. Determines the actual sending or reading account.
to
string (email)
optional
Recipient email for a new message. Replies use the original message's Reply-To or sender.
subject
string
optional
Subject for new mail. Replies retain the original thread subject.
body
string
required
Plain-text email body sent to the real recipient.
replyToMessageId
string
optional
Original Gmail message ID for a reply. Preserves its thread, subject and RFC reply headers.
attachments
object[]
optional
Optional files or durable Gmail attachment references, at most ten and 5 MB total decoded bytes. A reference has connectionId, messageId and partId. Default: []
idempotencyKey
string
required
Stable unique key for this intended send. Reuse on retries to prevent duplicate mail; choose a new key only for a new intentional message.
Over MCP the same operation is the tool gmail_reply at https://app.chirply.io/api/mcp, same bearer token, same input.
Search Gmail
gmail.searchread
Search the selected shared Gmail account using Gmail query syntax. Returns message bodies, attachment references and a next-page token; does not mark messages read in Gmail or send mail.
Parameters
Field
Type
Required
Description
connectionId
string (uuid)
required
ID of the Gmail account shared with this workspace. Determines the actual sending or reading account.
query
string
optional
Native Gmail search, such as from:customer@example.com has:attachment newer_than:7d. Default: "in:inbox"
pageToken
string
optional
Opaque nextPageToken from the preceding page; omit for the first page.
limit
integer
optional
Maximum messages to return on this page, from 1 to 50. Default: 20
Over MCP the same operation is the tool gmail_search at https://app.chirply.io/api/mcp, same bearer token, same input.
Send Gmail message
gmail.sendwriteconfirm
Send real email through the selected shared Gmail account, appearing in Gmail Sent. Google sending limits and account recipient opt-outs apply. Reuse idempotencyKey on retries; ambiguous deliveries are reconciled, never automatically resent.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Parameters
Field
Type
Required
Description
connectionId
string (uuid)
required
ID of the Gmail account shared with this workspace. Determines the actual sending or reading account.
to
string (email)
optional
Recipient email for a new message. Replies use the original message's Reply-To or sender.
subject
string
optional
Subject for new mail. Replies retain the original thread subject.
body
string
required
Plain-text email body sent to the real recipient.
replyToMessageId
string
optional
Original Gmail message ID for a reply. Preserves its thread, subject and RFC reply headers.
attachments
object[]
optional
Optional files or durable Gmail attachment references, at most ten and 5 MB total decoded bytes. A reference has connectionId, messageId and partId. Default: []
idempotencyKey
string
required
Stable unique key for this intended send. Reuse on retries to prevent duplicate mail; choose a new key only for a new intentional message.
Over MCP the same operation is the tool gmail_send at https://app.chirply.io/api/mcp, same bearer token, same input.
Sync new Gmail mail
gmail.syncwriteconfirm
Process one durable page of new mail for this Gmail connection. Adds incoming messages to Conversations and queues matching enabled workflows, which may send real mail or perform other configured actions. Replayed pages are deduplicated.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Parameters
Field
Type
Required
Description
connectionId
string (uuid)
required
ID of the Gmail account shared with this workspace. Determines the actual sending or reading account.