Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Rename a Gmail label or change its visibility and color.
gmail.updateLabel changes a user-owned label selected by display name or immutable ID.
import { automation } from "automate.ax"
import { gmail } from "automate.ax/gmail"
export default automation("Update a Gmail label", () => {
gmail.updateLabel({
color: {
backgroundColor: "#cc3a21",
textColor: "#ffffff",
},
label: "Automate.ax/Follow up",
name: "Automate.ax/Needs reply",
labelListVisibility: "labelShowIfUnread",
})
})
| 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: Gmail label color; textColor: Gmail label color } | No | Hex colors from Gmail’s supported label-color palette. |
Second argument: { account } | string | IntegrationAccountReference<"google"> | No | Google Account binding. Defaults to the project binding. |
name, labelListVisibility, messageListVisibility, or color. Inputs accept compatible signals.
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
}
labelId to avoid ambiguity when names may change.