POST /gmail/v1/users/{userId}/messages/{id}/modify ​
Modify labels applied to a message
| Detail | Value |
|---|---|
| Operation ID | modifyMessage |
| Method | POST |
| Path | /gmail/v1/users/{userId}/messages/{id}/modify |
| Connector | Gmail |
Parameters ​
| Name | Location | Type | Required |
|---|---|---|---|
userId | path | string | Yes |
id | path | string | Yes |
Request Body ​
| Field | Type |
|---|---|
addLabelIds | array |
removeLabelIds | array |
Using this endpoint in a workflow ​
- Add an API Call node to your workflow.
- Pick your Gmail connection from the Connection dropdown.
- In the Operation dropdown, select
modifyMessage. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
Required fields are marked — fill them or the call will fail at runtime.
What it returns ​
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Gmail API reference.