Actions181
- Account Actions
- Get Account
- Create Account
- Update Email
- Update Name
- Update Password
- Update Phone
- Update Status
- Get Preferences
- Update Preferences
- List Sessions
- Delete Sessions
- Get Session
- Update Session
- Delete Session
- Create Anonymous Session
- Create Email/Password Session
- Create Magic URL Session
- Create OAuth2 Session
- Create Phone Session
- Create Session from Token
- Create JWT
- Create Magic URL
- Create Phone Token
- Create Email Verification
- Update Email Verification
- Create Phone Verification
- Update Phone Verification
- Create Password Recovery
- Update Password Recovery
- Create Recovery
- Update Recovery
- Update MFA
- Create MFA Authenticator
- Update MFA Authenticator
- Delete MFA Authenticator
- Create MFA Challenge
- Update MFA Challenge
- Attribute Actions
- Avatars Actions
- Collection Actions
- Database Actions
- Document Actions
- Functions Actions
- Index Actions
- Locale Actions
- Messaging Actions
- Sites Actions
- Storage Actions
- Teams Actions
- Users Actions
Document → Delete
AI-generatedOverview
This node interacts with the Appwrite API to perform operations on documents within a specified database and collection. Specifically, the 'Delete' operation under the 'Document' resource allows users to delete a document by providing the database ID, collection ID, and document ID. This is useful for workflows that require automated removal of documents from Appwrite databases, such as cleaning up outdated records or managing data lifecycle.
Use Case Examples
- Deleting a user profile document from a user database when the user account is deactivated.
- Removing a log entry document from a collection after it has been processed.
Properties
| Name | Meaning |
|---|---|
| Database ID | The ID of the database where the document resides. |
| Collection ID | The ID of the collection within the database containing the document. |
| Document ID | The ID of the document to be deleted. |
Output
JSON
json- The response from the Appwrite API after attempting to delete the document, typically confirming deletion or providing error details.
Dependencies
- Requires an Appwrite API key credential for authentication, including endpoint URL, project ID, and API key.
Troubleshooting
- Ensure that the provided Database ID, Collection ID, and Document ID are correct and exist in the Appwrite project to avoid 'document not found' errors.
- Verify that the API key has sufficient permissions to delete documents in the specified database and collection.
- Common errors include authentication failures due to invalid API keys or insufficient permissions, and resource not found errors if IDs are incorrect.
Links
- Appwrite Delete Document API - Official documentation for deleting a document using the Appwrite API.