firestore.projects.databases.documents.patch

PATCH {{baseUrl}}/v1/:name?currentDocument.exists=<boolean>&currentDocument.updateTime=<string>&mask.fieldPaths=<string>&mask.fieldPaths=<string>&updateMask.fieldPaths=<string>&updateMask.fieldPaths=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

Updates or inserts a document.

Request Params

Key	Datatype	Description
`currentDocument.exists`	string	When set to `true`, the target document must exist. When set to `false`, the target document must not exist.
`currentDocument.updateTime`	string	When set, the target document must exist and have been last updated at that time.
`mask.fieldPaths`	string	The list of field paths in the mask. See Document.fields for a field path syntax reference.
`mask.fieldPaths`	string	The list of field paths in the mask. See Document.fields for a field path syntax reference.
`updateMask.fieldPaths`	string	The list of field paths in the mask. See Document.fields for a field path syntax reference.
`updateMask.fieldPaths`	string	The list of field paths in the mask. See Document.fields for a field path syntax reference.
`$.xgafv`	string	V1 error format.
`access_token`	string	OAuth access token.
`alt`	string	Data format for response.
`callback`	string	JSONP
`fields`	string	Selector specifying which fields to include in a partial response.
`key`	string	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`oauth_token`	string	OAuth 2.0 token for the current user.
`prettyPrint`	string	Returns response with indentations and line breaks.
`quotaUser`	string	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`upload_protocol`	string	Upload protocol for media (e.g. "raw", "multipart").
`uploadType`	string	Legacy upload protocol for media (e.g. "media", "multipart").

Request Body

{"createTime"=>"<string>", "fields"=>"<object>", "name"=>"<string>", "updateTime"=>"<string>"}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string

RESPONSES

status: OK

{&quot;createTime&quot;:&quot;\u003cstring\u003e&quot;,&quot;fields&quot;:&quot;\u003cobject\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;updateTime&quot;:&quot;\u003cstring\u003e&quot;}