Update label

updateLabel updates selected metadata on a user-owned Gmail label. Identify the label by display name or immutable ID, then provide at least one property to change.

Example

automations/update-follow-up-label.automation.ts

import { automation } from "automate.ax"
import { updateLabel } from "automate.ax/gmail"

export default automation("Update a Gmail label", () => {
  updateLabel({
    label: "Automate.ax/Follow up",
    name: "Automate.ax/Needs reply",
    labelListVisibility: "labelShowIfUnread",
  })
})

Inputs

Property	Type	Required	Description
`label`	`string`	Yes	Gmail label display name or immutable label ID.
`name`	`string`	No	Replacement label name.
`labelListVisibility`	`"labelHide" \| "labelShow" \| "labelShowIfUnread"`	No	Visibility in Gmail’s label list.
`messageListVisibility`	`"hide" \| "show"`	No	Visibility beside messages in Gmail’s message list.
`color`	`{ backgroundColor: string; textColor: string }`	No	Hex colors from Gmail’s supported label-color palette.
`account`	`string \| IntegrationAccountReference<"google">`	No	Google account binding to use. Defaults to the project’s default Google account binding.

Provide at least one of name, labelListVisibility, messageListVisibility, or color. Each input can also be a compatible Signal from an earlier trigger or action.

Output

Returns a Signal<GmailLabel> with the updated metadata:

interface GmailLabel {
  labelId: string
  name: string
  type?: "system" | "user"
  labelListVisibility?: "labelHide" | "labelShow" | "labelShowIfUnread"
  messageListVisibility?: "hide" | "show"
  color?: {
    backgroundColor: string
    textColor: string
  }
  messagesTotal?: number
  messagesUnread?: number
  threadsTotal?: number
  threadsUnread?: number
}

The action resolves display names case-insensitively. Use labelId to avoid ambiguity when names may change.

Gmail system labels cannot be renamed or restyled. Gmail also rejects color combinations outside its supported label-color palette.

Get started

Concepts

Reference

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output