Add Gmail Label

Node type: gmail_add_label · Version: 1 · Category: Communication Add or remove message labels. sndbox classifies this node as side-effecting, so tests or automatic runs can require additional confirmation and permission review.

When to use this node

Mark a processed message or move it through a label-based triage system.
Add and remove several Gmail labels in one reviewed action.

Example: Mark a message as processed

Map the triggered message ID, add the Processed label ID, and remove the Inbox label ID.

Example settings

{
  "credentialId": "gmail-support",
  "messageId": "{{trigger.email.messageId}}",
  "addLabelIds": [
    "Label_Processed"
  ],
  "removeLabelIds": [
    "INBOX"
  ]
}

This shows the important settings, not a complete exported node. Connection and profile IDs are illustrative; select the real resource in the inspector.

Use label IDs from Gmail rather than display names when required.
Map the exact message ID.
Run label changes after every earlier step whose failure should leave the message unprocessed.

Configuration

Field	Type	Default	What it controls
`credentialId`	string	`""`	Reference to a connection stored in the operating-system credential vault.
`messageId`	string	`""`	Gmail message or thread ID, usually mapped from a trigger or earlier Gmail node.
`addLabelIds`	array	`[]`	Gmail label IDs to add, one per line in the editor.
`removeLabelIds`	array	`[]`	Gmail label IDs to remove, one per line in the editor.

Workflow JSON

The editor stores this node with the following implemented default configuration:

Default node configuration

{
  "type": "gmail_add_label",
  "version": 1,
  "configuration": {
    "credentialId": "",
    "messageId": "",
    "addLabelIds": [],
    "removeLabelIds": []
  }
}

Values may be entered literally or mapped from an earlier compatible output when the inspector exposes a mapping control. See Variables and data mapping.

Inputs

This node has no typed ports in this direction.

Outputs

Port	Type	Required	Description
`result`	`any`	No	Result

Execution behavior

Adds and removals are submitted through the secure Gmail integration and mutate mailbox state.
An empty add or remove list is allowed, but at least one intended change makes the node useful.
The editor catalogue declares result (any) for mapping. The execution inspector can contain additional evidence fields; inspect a real result before selecting nested paths from object or any outputs.

Common issues

Display names can differ from provider label IDs.
If a run fails after labeling, decide whether the workflow needs a compensating label change.

Where it can run

Desktop local runner
Paired self-hosted runner
Hosted runner

Test and inspect

Use Test node in the editor to preview this step with the current configuration. A full run records resolved inputs, outputs, logs, duration, and any artifacts in the execution inspector. Side-effecting or destructive nodes can require an additional confirmation or approved workflow permission.

Node reference

Triggers

Logic

Data

Network

Browser

Communication

System

When to use this node

Example: Mark a message as processed

Configuration

Workflow JSON

Inputs

Outputs

Execution behavior

Common issues

Where it can run

Test and inspect

​When to use this node

​Example: Mark a message as processed

​Configuration

​Workflow JSON

​Inputs

​Outputs

​Execution behavior

​Common issues

​Where it can run

​Test and inspect

​Related guides

When to use this node

Example: Mark a message as processed

Configuration

Workflow JSON

Inputs

Outputs

Execution behavior

Common issues

Where it can run

Test and inspect

Related guides