Method: projects.databases.documents.patch

Updates or inserts a document.

HTTP request

PATCH https://firestore.googleapis.com/v1beta1/{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/{project_id}/databases/{database_id}/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/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Firestore