Method: projects.databases.documents.patch

Updates or inserts a document.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



The resource name of the document, for example projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Query parameters


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.


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.


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:


For more information, see the Authentication Overview.