--- title: "Connect Common Room and Gmail - APIANT.ai" description: "When \"Custom Fields List\" fires in Common Room, your agent runs \"Add Label To Email\" in Gmail." canonical: "https://apiant.ai/connect/common-room-to-gmail" --- # Connect Common Room and Gmail When **Custom Fields List** fires in [Common Room](https://apiant.ai/connections/common-room), your agent runs **Add Label To Email** in [Gmail](https://apiant.ai/connections/gmail), or **New Gmail Message** in Gmail to **Add Common Room Contact to Segment** in Common Room. Describe the whole flow and it is built, tested on every scenario and kept running. Common Room **2** triggers Common Room **11** actions Gmail **2** triggers Gmail **41** actions What the catalog holds today. Ask for anything missing and your agent reads the API documentation and adds it. ## What do you want Common Room and Gmail to do together? Give your AI client this address. `https://mcp.apiant.ai` One connection does both: ask your client to act in an app once, or have it build an automation that keeps running. Any client that takes a remote MCP server. Nothing to install. Create your free account, then sign in once in your browser. ### Set it up in your client ### Claude Code Run this in the directory you want to work in. `claude mcp add --transport http -s project apiant-ai https://mcp.apiant.ai` Start Claude Code there, approve the server, and sign in in the browser page it opens. [Claude Code guide (opens in a new tab)](https://apiant.ai/docs/mcp/claude-code) ### Claude, web and desktop Open Customize, then Connectors, then Add custom connector, and paste the address. On Team and Enterprise an owner adds it first. [Setup guide (opens in a new tab)](https://apiant.ai/docs/mcp) ### Cursor Add the address to your MCP configuration as a server URL. Cursor signs you in in your browser. [Setup guide (opens in a new tab)](https://apiant.ai/docs/mcp) ### Zed Open Settings, then AI, then MCP Servers, then Add Server, then Add Remote Server. [Setup guide (opens in a new tab)](https://apiant.ai/docs/mcp) ### Codex and the ChatGPT desktop app Open Settings, then MCP servers, then Add server, and choose Streamable HTTP. From the terminal, Codex takes the address with its own add command and then signs you in. [Setup guide (opens in a new tab)](https://apiant.ai/docs/mcp) ### Any other MCP client Paste the address where the client asks for a remote MCP server URL, and name the server apiant-ai where it lets you. APIANT's skills reach the client over the same connection. [Setup guide (opens in a new tab)](https://apiant.ai/docs/mcp) Example flows ## What Common Room and Gmail can do together ### From Common Room to Gmail - When **Custom Fields List** in Common Room then **Add Label To Email** in Gmail - When **Segment Status List** in Common Room then **Create Email Draft** in Gmail ### From Gmail to Common Room - When **New Gmail Message** in Gmail then **Add Common Room Contact to Segment** in Common Room - When **Email Sent** in Gmail then **Add or Update a Contact Custom Field** in Common Room Starting points drawn from the triggers and actions in the catalog today. Describe the flow you need, at any depth, and your agent builds it and tests every scenario before it ships. Everything your agent can do with Common Room and Gmail ## Triggers and actions 4 triggers · 52 actions - Trigger **Custom Fields List** Triggers when a new contact custom field is added to the Common Room community. - Trigger **Segment Status List** Triggers when a new status is added to the selected Common Room segment. - Action **Add Activity From Third Party Source** Adds an activity from a third-party system to a Common Room API signal source, or updates an activity previously added with the same activity ID and type. - Action **Add Common Room Contact to Segment** Adds one or more existing Common Room contacts to an existing segment, identified by email, Twitter, GitHub or LinkedIn, optionally setting their segment status. - Action **Add Organization From Third Party Source** Adds an organization to a Common Room API source, or updates the organization previously added with the same domain. - Action **Add or Update a Contact Custom Field** Sets the value of a contact custom field on a Common Room contact, creating or updating the contact in an API signal source. - Action **Add tag** Creates a tag in Common Room, or returns the existing tag if one with the same name already exists. - Action **Delete tag** Deletes a tag and removes it from everywhere it was applied. A tag that segments or workflows still use can't be deleted. - Action **Get tag** Returns a Common Room tag by its id, including its name, description and the entity types it may be assigned to. - Action **List activity types** Returns every activity type defined in your Common Room community, with its id and display name. - Action **List segments** Returns all segments in the Common Room community, with each segment's id and name. - Action **List tags** Returns all user-defined tags in your Common Room community, with their names, descriptions and the record types they can be applied to. - Action **Update tag** Renames a tag or changes its description. A deleted tag is restored when it is updated. - Trigger **Email Sent** Fires when an email is sent from the mailbox (optionally filtered by query). - Trigger **New Gmail Message** Fires when a new email arrives (optionally filtered by query/labels). - Action **Add Label To Email** Adds and/or removes specified gmail labels for a message; ensure `message id` and all `label ids` are valid (use 'listlabels' for custom label ids). - Action **Batch Delete Messages** Tool to permanently delete multiple Gmail messages in bulk, bypassing Trash with no recovery possible. Use when you need to efficiently remove large numbers of emails (e.g., retention enforcement, mailbox hygiene). Use GMAIL_MOVE_TO_TRASH instead when reversibility may be needed. Always obtain explicit user confirmation and verify a sample of message IDs before executing. High-volume calls may trigger 429 rateLimitExceeded or 403 userRateLimitExceeded errors; apply exponential backoff. - Action **Batch Modify Messages** Modify labels on multiple Gmail messages in one efficient API call. Supports up to 1,000 messages per request for bulk operations like archiving, marking as read/unread, or applying custom labels. High-volume calls may return 429 rateLimitExceeded or 403 userRateLimitExceeded; apply exponential backoff. - Action **Create Email Draft** Creates a gmail email draft, supporting to/cc/bcc, subject, plain/html body (ensure `is html=true` for html), attachments, and threading. - Action **Create Label** Creates a new label with a unique name in the specified user's gmail account. - Action **Delete Draft** Permanently deletes a specific gmail draft using its id; ensure the draft exists and the user has necessary permissions for the given `user id`. - Action **Delete Label** Permanently DELETES a user-created Gmail label from the account (not from a message). WARNING: This action DELETES the label definition itself, removing it from all messages. System labels (INBOX, SENT, UNREAD, etc.) cannot be deleted. To add/remove labels from specific messages, use GMAIL_ADD_LABEL_TO_EMAIL action instead. - Action **Delete Message** Permanently deletes a specific email message by its id from a gmail mailbox; for `user id`, use 'me' for the authenticated user or an email address to which the authenticated user has delegated access. - Action **Delete Thread** Tool to immediately and permanently delete a specified thread and all its messages. This operation cannot be undone. Use threads.trash instead for reversible deletion. - Action **Fetch Emails** Fetches a list of email messages from a gmail account, supporting filtering, pagination, and optional full content retrieval. - Action **Fetch Message By Message Id** Fetches a specific email message by its id, provided the `message id` exists and is accessible to the authenticated `user id`. - Action **Fetch Message By Thread Id** Retrieves messages from a gmail thread using its `thread id`, where the thread must be accessible by the specified `user id`. - Action **Forward Message** Forward an existing Gmail message to specified recipients, preserving original body and attachments. Verify recipients and content before forwarding to avoid unintended exposure. Bulk forwarding may trigger 429/5xx rate limits; keep concurrency to 5–10 and apply backoff. Messages near Gmail's size limits may fail; reconstruct a smaller draft if needed. - Action **Get Attachment** Retrieves a specific attachment by id from a message in a user's gmail mailbox, requiring valid message and attachment ids. - Action **Get Contacts** Fetches contacts (connections) for the authenticated google account, allowing selection of specific data fields and pagination. - Action **Get Draft** Retrieves a single Gmail draft by its ID. Use this to fetch and inspect draft content before sending via GMAIL_SEND_DRAFT. The format parameter controls the level of detail returned. - Action **Get Filter** Tool to retrieve a specific Gmail filter by its ID. Use when you need to inspect the criteria and actions of an existing filter. - Action **Get Label** Gets details for a specified Gmail label. Use this to retrieve label information including name, type, visibility settings, message/thread counts, and color. - Action **Get People** Retrieves either a specific person's details (using `resource name`) or lists 'other contacts' (if `other contacts` is true), with `person fields` specifying the data to return. - Action **Get Profile** Retrieves key gmail profile information (email address, message/thread totals, history id) for a user. - Action **Import Message** Tool to import a message into the user's mailbox with standard email delivery scanning and classification. Use when you need to add an existing email to a Gmail account without sending it through SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages. - Action **Insert Message** Tool to insert a message into the user's mailbox similar to IMAP APPEND. Use when you need to add an email directly to a mailbox bypassing most scanning and classification. This does not send a message. - Action **List Drafts** Retrieves a paginated list of email drafts from a user's gmail account. use verbose=true to get full draft details including subject, body, sender, and timestamp. - Action **List History** Tool to list Gmail mailbox change history since a known startHistoryId. Use for incremental mailbox syncs. Persist the latest historyId as a checkpoint across sessions; without it, incremental sync is unreliable. An empty history list in the response is valid and means no new changes occurred. - Action **List Labels** Retrieves a list of all system and user-created labels for the specified gmail account. - Action **List Smime Info** Lists S/MIME configs for the specified send-as alias. Use when you need to retrieve all S/MIME certificate configurations associated with a specific send-as email address. - Action **List Threads** Retrieves a list of email threads from a gmail account, identified by `user id` (email address or 'me'), supporting filtering and pagination. - Action **Modify Thread Labels** Adds or removes specified existing label ids from a gmail thread, affecting all its messages; ensure the thread id is valid. - Action **Move Thread To Trash** Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash. - Action **Move To Trash** Moves an existing, non-deleted email message to the trash for the specified user. - Action **Patch Label** Patches the specified label. - Action **Remove Label** Permanently deletes a specific, existing user-created gmail label by its id for a user; cannot delete system labels. - Action **Reply To Thread** Sends a reply within a specific gmail thread using the original thread's subject, requiring a valid `thread id` and correctly formatted email addresses. supports attachments via the `attachment` parameter with valid `s3key`, `mimetype`, and `name`. - Action **Search People** Searches contacts by matching the query against names, nicknames, emails, phone numbers, and organizations, optionally including 'other contacts'. - Action **Send Draft** Sends the specified, existing draft to the recipients in the to, cc, and bcc headers. - Action **Send Email** Sends an email via gmail api using the authenticated user's google profile display name, requiring `is html=true` if the body contains html and valid `s3key`, `mimetype`, `name` for any attachment. - Action **Settings Send As Get** Tool to retrieve a specific send-as alias configuration for a Gmail user. Use when you need to get details about a send-as email address including display name, signature, SMTP settings, and verification status. Fails with HTTP 404 if the specified address is not a member of the send-as collection. - Action **Untrash Message** Tool to remove a message from trash in Gmail. Use when you need to restore a previously trashed email message. - Action **Untrash Thread** Tool to remove a thread from trash in Gmail. Use when you need to restore a deleted thread and its messages. - Action **Update Draft** Updates (replaces) an existing Gmail draft's content in-place by draft ID. This action replaces the entire draft content with the new message - it does not patch individual fields. All fields are optional; if not provided, you should provide complete draft content to avoid data loss. - Action **Update Label** Tool to update the properties of an existing Gmail label. Use when you need to modify label name, visibility settings, or color. ## Each app on its own - [ **Common Room** Common Room is the intelligent community growth platform that helps you deepen relationships, build better...](https://apiant.ai/connections/common-room) - [ **Gmail** Gmail is Google’s email service, featuring spam protection, search functions, and seamless integration with...](https://apiant.ai/connections/gmail) Reviews ## What our customers say ## More from Common Room - [ **Common Room to HubSpot** HubSpot is your all-in-one stop for all of your marketing software needs.](https://apiant.ai/connect/common-room-to-hubspot) - [ **Common Room to Salesforce** Salesforce is a leading enterprise customer relationship management (CRM) platform.](https://apiant.ai/connect/common-room-to-salesforce) - [ **Common Room to Slack** Slack is a messaging platform for teams. Post messages, manage channels, users, reminders, and react to...](https://apiant.ai/connect/common-room-to-slack) - [ **Common Room to Google Sheets** Google Sheets is Google's online spreadsheet app for creating, editing and sharing spreadsheets.](https://apiant.ai/connect/common-room-to-google-sheets) - [ **Common Room to Google Calendar** Google Calendar is a time management tool providing scheduling features, event reminders, and integration...](https://apiant.ai/connect/common-room-to-google-calendar) - [ **Common Room to Google Drive** Google Drive is a cloud storage solution for uploading, sharing, and collaborating on files across devices...](https://apiant.ai/connect/common-room-to-google-drive) ## More into Gmail - [ **Slack to Gmail** Slack is a messaging platform for teams. Post messages, manage channels, users, reminders, and react to...](https://apiant.ai/connect/slack-to-gmail) - [ **Google Drive to Gmail** Google Drive is a cloud storage solution for uploading, sharing, and collaborating on files across devices...](https://apiant.ai/connect/google-drive-to-gmail) - [ **Mailchimp to Gmail** Mailchimp marketing automation and email platform.](https://apiant.ai/connect/mailchimp-to-gmail) - [ **Stripe to Gmail** Stripe is a payment processing platform for online businesses.](https://apiant.ai/connect/stripe-to-gmail) - [ **Shopify to Gmail** Shopify is a commerce platform for online stores and retail point-of-sale.](https://apiant.ai/connect/shopify-to-gmail) - [ **ActiveCampaign to Gmail** ActiveCampaign is a marketing automation, email marketing, and CRM platform.](https://apiant.ai/connect/activecampaign-to-gmail) Questions ## Common Room and Gmail, answered ### ### What can start an automation from Common Room? Any of Common Room's 2 triggers in the catalog, including Custom Fields List and Segment Status List. Describe the moment in plain language and your agent picks the right one. ### ### What can your agent do in Gmail when something happens in Common Room? Any of Gmail's 41 actions, including Create Email Draft, Create Label, Send Draft and Send Email. Your agent maps the data both ways and tests every scenario before it ships. ### ### Can it also run from Gmail to Common Room? Yes. When something happens in Gmail, your agent can act in Common Room too. This page covers both directions: Gmail's triggers and Common Room's actions are listed here as well. ### ### Do I have to build a connector for Common Room or Gmail? No. Both are in the catalog with their triggers and actions. You describe the automation; your agent builds it, tests every scenario and keeps it running. ### ### Can my AI client use Common Room and Gmail without building an automation? Yes. With your AI client connected to APIANT, ask it to do something in either app once and it runs that action on the spot. Ask for an automation and your agent builds it, tests every scenario and keeps it running. One connection covers both. ### ### What happens when something fails? Your agent works that out for you. It plans the failure paths along with the happy path, then tests every scenario before it ships. ### ### Is there a free plan? Yes. Every plan includes the agent, including free, and building from your own AI client spends no assistant credits.