Delete label

gmail.deleteLabel permanently deletes a user-owned label without deleting labeled messages or threads. Use an immutable label ID when possible. The action resolves display names case-insensitively against the connected mailbox.

Example

automations/delete-old-label.automation.ts

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

export default automation("Delete an obsolete Gmail label", () => {
  gmail.deleteLabel({
    label: "Automate.ax/Old",
  })
})

Inputs

Property	Type	Required	Description
`label`	`string`	Yes	Gmail label display name or immutable label ID.
Second argument: `{ account }`	`string \| IntegrationAccountReference<"google">`	No	Google Account binding. Defaults to the project binding.

Inputs accept compatible signals.

Output

Returns the deleted label’s immutable ID as a Signal<string>.

Deletion cannot be undone. Gmail system labels such as INBOX, SPAM, and TRASH cannot be deleted.

The action fails before deletion when no label in the connected mailbox matches the supplied name or ID.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output