Modifies the labels on the specified message.
HTTP request
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/modify
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
userId
|
The user's email address. The special value |
id
|
The ID of the message to modify. |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "addLabelIds" : [ string ] , "removeLabelIds" : [ string ] } |
| Fields | |
|---|---|
addLabelIds[]
|
A list of IDs of labels to add to this message. You can add up to 100 labels with each update. |
removeLabelIds[]
|
A list IDs of labels to remove from this message. You can remove up to 100 labels with each update. |
Response body
If successful, the response body contains an instance of Message
.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://mail.google.com/ -
https://www.googleapis.com/auth/gmail.modify
For more information, see the Authorization guide .
