Action: Archive Email

Gmail Operation

The Archive Email action removes an email from your inbox and stores it in the "All Mail" folder for future reference.

Example User Story

I want to archive completed project emails to keep my inbox clean while still having access to them later.

Fields

Field Name	Field Type	Required
messageId	String	Yes

Related Connections

Gmail

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "archive-email",
  "state": "inDev",
  "meta": {
    "short": "Archive Email",
    "description": "Archives an email in Gmail."
  },
  "input": [
    {
      "name": "messageId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the email message to archive."
      }
    }
  ],
  "output": [
    {
      "name": "success",
      "type": "Boolean",
      "selector": ["success"],
      "meta": {
        "description": "Indicates whether the email was successfully archived."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/gmail/v1/users/me/messages/{{messageId}}/modify",
        "headers": {
          "Content-Type": "application/json"
        },
        "bodyTemplate": {
          "value": "{\"removeLabelIds\": [\"INBOX\"], \"addLabelIds\": []}",
          "placeholders": [
            {
              "name": "accessToken",
              "type": "String",
              "description": "The OAuth access token for authenticating with Gmail.",
              "required": true
            }
          ]
        }
      }
    }
  ]
}