Method: projects.databases.documents.createDocument
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/**}/{collectionId}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent resource. For example: projects/{projectId}/databases/{databaseId}/documents or projects/{projectId}/databases/{databaseId}/documents/chatrooms/{chatroom_id}
|
collectionId |
string
Required. The collection ID, relative to parent, to list. For example: chatrooms.
|
Query parameters
| Parameters |
documentId |
string
The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.
|
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.
|
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/datastorehttps://www.googleapis.com/auth/cloud-platform
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-20 UTC.
[null,null,["Last updated 2025-06-20 UTC."],[],[],null,["Creates a new document.\n\nHTTP request\n\n`POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/**}/{collectionId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\nQuery parameters\n\nRequest body\n\nThe request body contains an instance of [Document](/docs/firestore/reference/rest/v1/projects.databases.documents#Document).\n\nResponse body\n\nIf successful, the response body contains an instance of [Document](/docs/firestore/reference/rest/v1/projects.databases.documents#Document).\n\nAuthorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/datastore`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
