This endpoint allows you to modify certain properties of an existing collection, such as its description or configuration settings. The collection name cannot be changed once it’s created.
API endpoint
PATCH /v1/collections/{collection_name}
Path parameters
Parameter
Type
Required
Description
collection_name
string
Yes
Name of the collection to update
Request body
The request body should contain a JSON object with the properties you want to update:
Parameter
Type
Required
Description
description
string
No
New description for the collection
Example request body:
{
"description":"Updated collection of premium electronics products"
}
Response
A successful update returns a 200 OK status code and a JSON response containing the updated collection:
{
"name":"products",
"description":"Updated collection of premium electronics products",
The GET endpoint retrieves detailed collection information including metadata schema and object counts by using a unique collection name while returning a JSON response with appropriate status codes and error handling.
Collections must be created with unique names before adding objects to Tallyfy Answers which automatically detects data types like strings and string lists when indexing through a POST API endpoint.
The DELETE endpoint permanently removes collections and their objects through a straightforward API call while offering best practices and alternatives to mitigate risks of irreversible data loss.
Collections in Tallyfy Answers serve as organizational containers that group similar objects together while enabling operations like searching filtering and managing data through dynamic schemas and efficient organization methods.