Method: users.messages.modify

Modifie les libellés et les valeurs de libellé de classification du message spécifié. Pour les administrateurs qui modifient des messages pour les utilisateurs de leur organisation, les requêtes nécessitent une autorisation avec un compte de service disposant d'une délégation à l'échelle du domaine pour emprunter l'identité des utilisateurs avec le champ d'application https://www.googleapis.com/auth/gmail.modify.restricted.

Requête HTTP

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/modify

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
userId

string

Adresse e-mail de l'utilisateur. La valeur spéciale me peut être utilisée pour indiquer l'utilisateur authentifié.
id

string

ID du message à modifier.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
Champs
addLabelIds[]

string

Liste des ID des libellés à ajouter à ce message. Vous pouvez ajouter jusqu'à 100 libellés à chaque mise à jour.
removeLabelIds[]

string

Liste des ID des libellés à supprimer de ce message. Vous pouvez supprimer jusqu'à 100 libellés à chaque mise à jour.
addClassificationLabels[]

object (ClassificationLabelValue)

Liste des valeurs de libellé de classification à ajouter. Si un libellé de classification avec le même ID de libellé est déjà appliqué au message, les champs avec des ID de champ existants seront mis à jour et les champs avec de nouveaux ID de champ seront ajoutés. Vous ne pouvez ajouter que 20 valeurs de libellé de classification par requête. Si le message est déjà classé et que le nombre total final de valeurs de libellé de classification dépasse le nombre maximal autorisé de valeurs de libellé de classification par message, la modification échoue.
removeClassificationLabelIds[]

string

Liste des valeurs de libellé de classification à supprimer de ce message.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Message.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.modify.restricted

Pour en savoir plus, consultez le guide d'autorisation.