Workflow blocks
Archive Email
Archive a Gmail message (remove INBOX label)
gmail/archive-email — Archive a Gmail message (remove INBOX label).
Where it appears
The Archive Email block lives in the Integrations group of the Workflow Builder. Connect the Gmail integration before adding it.
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | text (supports references) | Yes | — | Gmail message ID to act on. Use a literal ID or <StepName.field> to reference an ID from a previous step (e.g. a search result). |
Inputs and outputs
Inputs are the configurable fields above. The block produces these outputs:
Outputs
Reference an output downstream with <Archive Email.field>.
| Name | Type | Description |
|---|---|---|
success | boolean | Operation succeeded |
modified | boolean | Message was modified |
message | json | Archived message |
error | string | Error message if failed |
Example
A minimal configuration for this block:
{
"type": "gmail/archive-email",
"config": {
"messageId": "<PreviousStep.field>"
}
}Limits and failure modes
- Requires a connected Gmail integration. Calls fail if that integration is disconnected or its authorization has expired.
- Required field (
messageId) must be set, or the block fails validation before it runs. - On failure the
erroroutput is populated; downstream blocks that reference other outputs may not receive values.