Skip to content

Delete a collection

Deleting collections

This endpoint allows you to permanently remove a collection and all its objects from Tallyfy Answers. This operation is irreversible and should be used with caution.

Permanent Action

Deleting a collection permanently removes all objects within it. This action cannot be undone, and there is no way to recover the data once deleted.

API endpoint

DELETE /v1/collections/{collection_name}

Path parameters

ParameterTypeRequiredDescription
collection_namestringYesName of the collection to delete

Response

A successful deletion returns a 200 OK status code with a confirmation response:

{
"name": "products",
"status": "deleted"
}

Error scenarios

StatusDescription
404Collection not found
400Invalid collection name format
403Permission denied (if applicable)

Example request

Terminal window
curl -X DELETE https://go.tallyfy.com/api/collections/products \
-H "X-Answers-API-Key: your_api_key"

When to delete a collection

Consider deleting a collection when:

  • The data is no longer needed for any purpose
  • You need to rebuild a collection with a different structure
  • You want to remove test or development data
  • You’re performing cleanup of unused resources

Alternatives to deletion

Instead of permanently deleting a collection, consider these alternatives:

  • Export the data before deletion for backup purposes
  • Create a new collection with only the objects you want to keep
  • Use application-level filtering to hide certain objects from users

Best practices

  • Always confirm collection names before deletion
  • Consider implementing a confirmation step in your application
  • Back up important data before deletion
  • Use descriptive logging to track deletion operations
  • Verify permissions carefully to prevent unauthorized deletions

Objects > Delete an object

The DELETE endpoint permanently removes specific objects from Tallyfy Answers collections using unique identifiers with no recovery option and returns confirmation upon successful deletion.

Collections > Get a collection

The Tallyfy Answers API endpoint allows fetching detailed information about a specific collection including its metadata schema and object counts using a GET request with the collection name as a path parameter.

Collections > Update a collection

The PATCH endpoint enables modification of existing collection properties like descriptions in Tallyfy Answers while maintaining immutable collection names and providing structured JSON responses with error handling.

Objects > Get an object

The Tallyfy Answers API provides a GET endpoint that retrieves individual objects from collections using their unique identifier and returns complete object data with all properties including system-generated timestamps.