Modify labels

Example

Move new messages from a Triage label to a Processed label:

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

export default automation("Update Gmail workflow labels", () => {
  const email = gmail.onNewEmail()

  gmail.modifyLabels({
    add: ["Processed"],
    messageIds: email.messageId,
    remove: ["Triage"],
  })
})

Both labels must already exist in the selected Gmail account.

Inputs

Name	Type	Required	Description
`add`	`string \| string[]`	No	Existing label display names or immutable IDs to add.
`messageIds`	`string \| string[]`	Yes	One or up to 1,000 immutable Gmail message IDs.
`remove`	`string \| string[]`	No	Existing label display names or immutable IDs to remove.
Second argument: `{ account }`	`string \| Google account reference`	No	Google Account binding. Defaults to the project binding.

Provide at least one non-empty add or remove list. Inputs accept compatible signals.

Label IDs must match exactly. The action matches display names after trimming surrounding whitespace and ignoring capitalization. You may mix names and IDs in either list. If the action can’t resolve a requested label, it fails before modifying messages.

The action changes labels on individual messages. Supplying Gmail system labels such as INBOX, UNREAD, or STARRED changes the corresponding Gmail state.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output