Method: projects.databases.documents.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates or inserts a document.
HTTP request
PATCH https://firestore.googleapis.com/v1/{document.name=projects/*/databases/*/documents/*/**}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
document.name |
string
The resource name of the document, for example projects/{projectId}/databases/{databaseId}/documents/{document_path}.
|
Query parameters
| Parameters |
updateMask |
object (DocumentMask)
The fields to update. None of the field paths in the mask may contain a reserved name. If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server.
|
mask |
object (DocumentMask)
The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.
|
currentDocument |
object (Precondition)
An optional precondition on the document. The request will fail if this is set and not met by the target document.
|
Request body
The request body contains an instance of Document.
Response body
If successful, the response body contains an instance of Document.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-20 UTC.
[null,null,["Last updated 2025-06-20 UTC."],[],[],null,["# Method: projects.databases.documents.patch\n\nUpdates or inserts a document.\n\n### HTTP request\n\n`PATCH https://firestore.googleapis.com/v1/{document.name=projects/*/databases/*/documents/*/**}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `document.name` | `string` The resource name of the document, for example `projects/{projectId}/databases/{databaseId}/documents/{document_path}`. |\n\n### Query parameters\n\n| Parameters ||\n|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `object (`[DocumentMask](/docs/firestore/reference/rest/v1/DocumentMask)`)` The fields to update. None of the field paths in the mask may contain a reserved name. If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. |\n| `mask` | `object (`[DocumentMask](/docs/firestore/reference/rest/v1/DocumentMask)`)` The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. |\n| `currentDocument` | `object (`[Precondition](/docs/firestore/reference/rest/v1/Precondition)`)` An optional precondition on the document. The request will fail if this is set and not met by the target document. |\n\n### Request body\n\nThe request body contains an instance of [Document](/docs/firestore/reference/rest/v1/projects.databases.documents#Document).\n\n### Response body\n\nIf successful, the response body contains an instance of [Document](/docs/firestore/reference/rest/v1/projects.databases.documents#Document).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/datastore`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
