Click here to see your recently viewed pages and most viewed pages.

Files: patch

Requires authorization

Updates file metadata. This method supports patch semantics. Try it now or see an example.


HTTP request



Parameter name Value Description
Path parameters
fileId string The ID of the file to update.
Optional query parameters
addParents string Comma-separated list of parent IDs to add.
convert boolean Whether to convert this file to the corresponding Google Docs format. (Default: false)
newRevision boolean Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous revisions are preserved (causing increased use of the user's data storage quota). (Default: true)
ocr boolean Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. (Default: false)
ocrLanguage string If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes.
pinned boolean Whether to pin the new revision. A file can have a maximum of 200 pinned revisions. (Default: false)
removeParents string Comma-separated list of parent IDs to remove.
setModifiedDate boolean Whether to set the modified date with the supplied modified date. (Default: false)
timedTextLanguage string The language of the timed text.
timedTextTrackName string The timed text track name.
updateViewedDate boolean Whether to update the view date after successfully updating the file. (Default: true)
useContentAsIndexableText boolean Whether to use the content as indexable text. (Default: false)


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


Request body

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


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


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).


Uses the Java client library.


// ...

public class MyClass {

  // ...

   * Rename a file.
   * @param service Drive API service instance.
   * @param fileId ID of the file to rename.
   * @param newTitle New title for the file.
   * @return Updated file metadata if successful, {@code null} otherwise.
  private static File renameFile(Drive service, String fileId, String newTitle) {
    try {
      File file = new File();

      // Rename the file.
      Files.Patch patchRequest = service.files().patch(fileId, file);

      File updatedFile = patchRequest.execute();
      return updatedFile;
    } catch (IOException e) {
      System.out.println("An error occurred: " + e);
      return null;

  // ...


Uses the .NET client library.

using Google.Apis.Drive.v2;
using Google.Apis.Drive.v2.Data;

// ...

public class MyClass {

  // ...

  /// <summary>
  /// Rename a file.
  /// </summary>
  /// <param name="service">Drive API service instance.</param>
  /// <param name="fileId">ID of the file to rename.</param>
  /// <param name="newTitle">New title for the file.</param>
  /// <returns>Updated file metadata, null is returned if an API error occurred.</returns>
  private static File renameFile(DriveService service, String fileId, String newTitle) {
      try {
          File file = new File();
          file.Title = newTitle;

          // Rename the file.
          FilesResource.PatchRequest request = service.Files.Patch(file, fileId);
          File updatedFile = request.Execute();

          return updatedFile;
      } catch (Exception e) {
          Console.WriteLine("An error occurred: " + e.Message);
          return null;




Uses the PHP client library.

 * Rename a file.
 * @param Google_Service_Drive $service Drive API service instance.
 * @param string $fileId ID of the file to rename.
 * @param string $newTitle New title for the file.
 * @return Google_Service_Drive_DriveFile The updated file. NULL is returned if
 *     an API error occurred.
function renameFile($service, $fileId, $newTitle) {
  try {
    $file = new Google_Service_Drive_DriveFile();

    $updatedFile = $service->files->patch($fileId, $file, array(
      'fields' => 'title'

    return $updatedFile;
  } catch (Exception $e) {
    print "An error occurred: " . $e->getMessage();


Uses the Python client library.

from apiclient import errors
# ...

def rename_file(service, file_id, new_title):
  """Rename a file.

    service: Drive API service instance.
    file_id: ID of the file to rename.
    new_title: New title for the file.
    Updated file metadata if successful, None otherwise.
    file = {'title': new_title}

    # Rename the file.
    updated_file = service.files().patch(

    return updated_file
  except errors.HttpError, error:
    print 'An error occurred: %s' % error
    return None


Uses the Ruby client library.

# Rename a file
# @param [Google::APIClient] client
#   Authorized client instance
# @param [String] file_id
#   ID of file to update
# @param [String] title
#   New title of file
# @return [Google::APIClient::Schema::Drive::V2::File]
#   File if update, nil otherwise
def rename_file(client, file_id, title)
  drive = client.discovered_api('drive', 'v2')
  result = client.execute(
    :api_method => drive.files.patch,
    :body_object => { 'title' => title },
    :parameters => { 'fileId' => file_id })
  if result.status == 200
  puts "An error occurred: #{['error']['message']}"
  return nil


Uses the JavaScript client library.

 * Rename a file.
 * @param {String} fileId <span style="font-size: 13px; ">ID of the file to rename.</span><br> * @param {String} newTitle New title for the file.
function renameFile(fileId, newTitle) {
  var body = {'title': newTitle};
  var request ={
    'fileId': fileId,
    'resource': body
  request.execute(function(resp) {
    console.log('New Title: ' + resp.title);


Uses the Go client library.

import (

// RenameFile renames a given file to a given title
func RenameFile(d *drive.Service, fileId string,
    title string) (*drive.File, error) {
  f := &drive.File{Title: title}
  r, err := d.Files.Patch(fileId, f).Do()
  if err != nil {
    fmt.Printf("An error occurred: %v\n", err)
    return nil, err
  return r, nil


Uses the Objective-C client library.

#import "GTLDrive.h"
// ...

+ (void)renameFileWithService:(GTLServiceDrive *)service
                       fileId:(NSString *)fileId
                     newTitle:(NSString *)newTitle
              completionBlock:(void (^)(GTLDriveFile *, NSError *))completionBlock {
  GTLDriveFile *file = [GTLDriveFile object];
  file.title = newTitle;

  GTLQueryDrive *query = [GTLQueryDrive queryForFilesPatchWithObject:file
  // queryTicket can be used to track the status of the request.
  GTLServiceTicket *queryTicket =
    [service executeQuery:query
        completionHandler:^(GTLServiceTicket *ticket, GTLDriveFile *updatedFile,
                            NSError *error) {
        if (error == nil) {
          completionBlock(updatedFile, nil);
        } else {
          NSLog(@"An error occurred: %@", error);
          completionBlock(nil, error);

// ...

Try it!

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