Method: projects.databases.bulkDeleteDocuments
Stay organized with collections
Save and categorize content based on your preferences.
Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created.
For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete
HTTP request
POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:bulkDeleteDocuments
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Database to operate. Should be of the form: projects/{projectId}/databases/{databaseId}.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"collectionIds": [
string
],
"namespaceIds": [
string
]
} |
| Fields |
collectionIds[] |
string
Optional. IDs of the collection groups to delete. Unspecified means all collection groups. Each collection group in this list must be unique.
|
namespaceIds[] |
string
Optional. Namespaces to delete. An empty list means all namespaces. This is the recommended usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to delete from them. Each namespace in this list must be unique.
|
Response body
If successful, the response body contains an instance of Operation.
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,["# Method: projects.databases.bulkDeleteDocuments\n\nBulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created.\n\nFor more details on bulk delete behavior, refer to: \u003chttps://cloud.google.com/firestore/docs/manage-data/bulk-delete\u003e\n\n### HTTP request\n\n`POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*}:bulkDeleteDocuments`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Database to operate. Should be of the form: `projects/{projectId}/databases/{databaseId}`. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------|\n| ``` { \"collectionIds\": [ string ], \"namespaceIds\": [ string ] } ``` |\n\n| Fields ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `collectionIds[]` | `string` Optional. IDs of the collection groups to delete. Unspecified means all collection groups. Each collection group in this list must be unique. |\n| `namespaceIds[]` | `string` Optional. Namespaces to delete. An empty list means all namespaces. This is the recommended usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to delete from them. Each namespace in this list must be unique. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/docs/firestore/reference/rest/Shared.Types/Operation).\n\n### Authorization 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)."]]
