Unstar - Automate.ax

gmail.unstarMessages removes Gmail’s STARRED label from messages.

Example

Remove the star from messages after applying a Completed label:

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

export default automation("Complete starred Gmail work", () => {
  const email = gmail.onNewEmail()
  const completedMessageIds = gmail.addLabel({
    labels: ["Completed"],
    messageIds: email.messageId,
  })

  gmail.unstarMessages({ messageIds: completedMessageIds })
})

The Completed label must already exist in the selected Gmail account.

Inputs

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

Inputs accept compatible signals.

Output

Returns a Signal<string[]> with the modified message IDs in input order. This removes the standard STARRED label from individual messages. It doesn’t change unrelated labels or other messages in the same thread.