Explore Connect Docs Changelog Pricing Templates Partners

Add Label to Email with Gmail API

Pipedream makes it easy to connect APIs for Gmail and 2,500+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Add Label to Email with the Gmail API

No credit card required

Intro to Pipedream

▶

Watch us build a workflow

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Chase Roberts
@chsrbrts
@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨
@heyellieday
Evaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley
@MBraedley
Update: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting
@mrthomascutting
Want quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts
@mattdotroberts
day 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭
@auchenberg
Yahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑
@raymondcamden
Awesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero
@nachocaballero
I couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow
@jyksnw
Developed a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana
@steven_terrana
@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD
@DotDotJames
Want to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin
@Atinux
GitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul
@raul_predescu
If you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc
@bitfalls
So @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich
@ZachLanich
Um, wow 🤯 @pipedream
Steven Bell
@bellontech
I just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸
@_jayhack_
Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴‍♂️🌳
@philsturgeon
For context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.

Getting Started#

Create a workflow to Add Label to Email with the Gmail API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Add Label to Email action
1. Connect your Gmail account
2. Select a Message
3. Select one or more Labels
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Add Label to Email with Gmail API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Gmail

Add Label to Email with Gmail API on New Submission from Typeform API

Typeform + Gmail

Add Label to Email with Gmail API on New Submission (Instant) from Jotform API

Jotform + Gmail

Add Label to Email with Gmail API on New Scheduled Tasks from Pipedream API

Pipedream + Gmail

Add Label to Email with Gmail API on New Download Counts from npm API

npm + Gmail

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Add Label to Email on Gmail

Description:Add label(s) to an email message. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify)

Version:0.0.8

Key:gmail-add-label-to-email

Code#

import gmail from "../../gmail.app.mjs";

export default {
  key: "gmail-add-label-to-email",
  name: "Add Label to Email",
  description: "Add label(s) to an email message. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify)",
  version: "0.0.8",
  type: "action",
  props: {
    gmail,
    message: {
      propDefinition: [
        gmail,
        "message",
      ],
    },
    addLabelIds: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
    },
  },
  async run({ $ }) {
    const {
      gmail,
      message,
      addLabelIds = [],
    } = this;

    const response = await gmail.updateLabels({
      message,
      addLabelIds,
    });

    $.export("$summary", `Successfully added ${addLabelIds.length} label(s)`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Gmail	`gmail`	`app`	This component uses the Gmail app.
Message	`message`	`string`	Select a value from the drop down menu.
Labels	`addLabelIds`	`string[]`	Select a value from the drop down menu.

Authentication#

Gmail uses OAuth authentication. When you connect your Gmail account, Pipedream will open a popup window where you can sign into Gmail and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Gmail API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

More Ways to Use Gmail#

Triggers#

New Attachment Received from the Gmail API

Emit new event for each attachment in a message received. This source is capped at 100 max new messages per run.

New Email Matching Search from the Gmail API

Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.

New Email Received from the Gmail API

Emit new event when a new email is received.

New Labeled Email from the Gmail API

Emit new event when a new email is labeled.

New Sent Email from the Gmail API

Emit new event for each new email sent. (Maximum of 100 events emited per execution)

Actions#

Approve Workflow with the Gmail API

Suspend the workflow until approved by email. See the documentation

Archive Email with the Gmail API

Archive an email message. See the documentation

Create Draft with the Gmail API

Create a draft from your Google Workspace email account. See the documentation

Download Attachment with the Gmail API

Download an attachment by attachmentId to the /tmp directory. See the documentation

Find Email with the Gmail API

Find an email using Google's Search Engine. See the docs

Explore Other Apps#

1
-
24
of
2,500+
apps by most popular

HTTP / Webhook

Get a unique URL where you can send HTTP or webhook requests

Node

Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.

Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.

Pipedream Utils

Utility functions to use within your Pipedream workflows

OpenAI (ChatGPT)

OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.

Cloud-based customer relationship management (CRM) platform that helps businesses manage sales, marketing, customer support, and other business activities, ultimately aiming to improve customer relationships and streamline operations.

HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.

Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.

Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

WooCommerce

WooCommerce is the open-source ecommerce platform for WordPress.

A data warehouse built for the cloud

MongoDB is an open source NoSQL database management program.

Supabase is an open source Firebase alternative.

MySQL is an open-source relational database management system.

PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.

AWS

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Twilio SendGrid

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation

Email Marketing and SMS Marketing Platform

Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.

The smarter way to workflow

Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

a b c d e f g h i j k l m n o p q r s t u v w x y z #