Users.labels: patch

Requires authorization

Updates the specified label. This method supports patch semantics. Try it now or see an example.

Request

HTTP request

PATCH https://www.googleapis.com/gmail/v1/users/userId/labels/id

Parameters

Parameter name Value Description
Path parameters
id string The ID of the label to update.
userId string The user's email address. The special value me can be used to indicate the authenticated user.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.labels

Request body

In the request body, supply the relevant portions of a Users.labels resource, according to the rules of patch semantics.

Response

If successful, this method returns a Users.labels resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

import com.google.api.services.gmail.Gmail;
import com.google.api.services.gmail.model.Label;

import java.io.IOException;

// ...

public class MyClass {

  // ...

  /**
   * Updates the specified label.
   *
   * @param service Authorized Gmail API instance.
   * @param userId User's email address. The special value "me"
   * can be used to indicate the authenticated user.
   * @param labelId ID of Label to patch.
   * @param labelPatch Label with properties to patch.
   * @throws IOException
   */
  public static void patchLabel(Gmail service, String userId, String labelId, Label labelPatch)
      throws IOException {
    Label patchedLabel = service.users().labels().patch(userId, labelId, labelPatch).execute();

    System.out.println("Label with ID " + labelId + " patched sucessfully.");
    System.out.println(patchedLabel.toPrettyString());
  }

  // ...
}

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Enviar comentarios sobre…

¿Necesitas ayuda? Visita nuestra página de asistencia.