Firestore.projects.databases.documents.create Document

Creates a new document.

POST/v1/{parent}/{collectionId}

Use it in a workflow

Add a step and choose the Firestore connector.
Pick the Firestore.projects.databases.documents.create Document action (under projects).
Fill in the fields below, then reference the result from later steps as {{firestoreProjectsDatabasesDocumentsCreateDocument.response.data}}.

Request

Path parameters

parentstringrequired

Required. The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`

collectionIdstringrequired

Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.

Query parameters

$.xgafvstring

V1 error format.

One of12

access_tokenstring

OAuth access token.

altstring

Data format for response.

One ofjsonmediaproto

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

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_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

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_protocolstring

Upload protocol for media (e.g. "raw", "multipart").

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart").

documentIdstring

The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

mask.fieldPathsarray<string>

The list of field paths in the mask. See Document.fields for a field path syntax reference.

Request body

Enter the body as JSON in the step's Body field.

createTimestring (google-datetime)

Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.

fieldsobject

The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.

namestring

The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

updateTimestring (google-datetime)

Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query.

json

{
  "createTime": "string",
  "fields": {},
  "name": "string",
  "updateTime": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{firestoreProjectsDatabasesDocumentsCreateDocument.response.data.<field>}}.