firestore.projects.databases.documents.create Document

POST {{baseUrl}}/v1/:parent/:collectionId?documentId=<string>&mask.fieldPaths=<string>&mask.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>

Creates a new document.

Request Params

KeyDatatypeRequiredDescription
documentIdstringThe client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.
mask.fieldPathsstringThe list of field paths in the mask. See Document.fields for a field path syntax reference.
mask.fieldPathsstringThe list of field paths in the mask. See Document.fields for a field path syntax reference.
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI 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_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable 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_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").

Request Body

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

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

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;}