Method: projects.databases.documents.delete
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
DELETE https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The resource name of the Document to delete. In the format: projects/{projectId}/databases/{databaseId}/documents/{document_path}.
|
Query parameters
| Parameters |
currentDocument |
object (Precondition)
An optional precondition on the document. The request will fail if this is set and not met by the target document.
|
Request body
The request body must be empty.
Response body
If successful, the response body is an empty JSON object.
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.documents.delete\n\nDeletes a document.\n\n### HTTP request\n\n`DELETE https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The resource name of the Document to delete. In the format: `projects/{projectId}/databases/{databaseId}/documents/{document_path}`. |\n\n### Query parameters\n\n| Parameters ||\n|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `currentDocument` | `object (`[Precondition](/docs/firestore/reference/rest/v1/Precondition)`)` An optional precondition on the document. The request will fail if this is set and not met by the target document. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\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)."]]
