GMail integration

Modify Message Labels

Perform Modify Message Labels through GMail.

View as Markdown

gmail_modify_message_labels

write

Inputs

message_id
expressionrequired
Message Id
Required literal value or workflow expression.
add_labels
text
Add Labels
Optional text value.
remove_labels
text
Remove Labels
Optional text value.
create_missing_labels
boolean
Create Missing Labels
Optional true-or-false value.
Default: false
dry_run
boolean
Dry Run
Optional true-or-false value.
Default: false

Outputs

successSuccess
message_idMessage Id
added_labelsAdded Labels
removed_labelsRemoved Labels
created_labelsCreated Labels
skipped_labelsSkipped Labels
dry_runDry Run
errorError
error_messageError Message
error_codeError Code

Output schema completeness: best_effort_declared

Safety

External effect: write
Confirmation recommended: No
Retry safe: No
Dry run supported: Yes

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema

{
  "type": "object",
  "required": [
    "message_id"
  ],
  "properties": {
    "dry_run": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "add_labels": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "message_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "remove_labels": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "create_missing_labels": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "dry_run": {},
    "success": {},
    "error_code": {},
    "message_id": {},
    "added_labels": {},
    "error_message": {},
    "created_labels": {},
    "removed_labels": {},
    "skipped_labels": {}
  },
  "additionalProperties": true
}

View all GMail actions