Using the COLLECTIONS UPDATE API, you can UPDATE Collections name for now. We might add more meta data to the Collections which you can use the Update API for.

Request Type
Request Headers
Header Value Required
Content-Type application/json Yes
secret-key <YOUR_SECRET_KEY> Yes
schema-doc-id <SCHEMA_DOC_ID> No
remove-schema-doc true No

Content-Type needs to be set to application/json. The request will result in an error in-case of a missing Content-Type header.


secret-key is required when you need to Update a Collection. You can find your secret-key on the API Keys page after signing-in.

Basic Code Samples
curl \
 --header "Content-Type: application/json" \
 --header "secret-key: <SECRET_KEY>" \
 --request PUT \
 --data '{"name": "Sample Collection Updated"}' \<COLLECTION_ID>
let req = new XMLHttpRequest();

req.onreadystatechange = () => {
  if (req.readyState == XMLHttpRequest.DONE) {
};"PUT", "<COLLECTION_ID>", true);
req.setRequestHeader("Content-Type", "application/json");
req.setRequestHeader("secret-key", "<SECRET_KEY>");
req.send('{"name": "Sample Collection Updated"}');
import requests
headers = {
  'Content-Type': 'application/json', 
  'secret-key': '<SECRET_KEY>'
data = {"name": "Sample Collection Updated"}

req = requests.put(url, json=data, headers=headers)
require 'net/http'
require 'json'

res = Net::HTTP.start(, uri.port, use_ssl: true) do |http|
  req =
  req['Content-Type'] = 'application/json'
  req['secret-key'] = '<SECRET_KEY>'

  req.body = {"name": "Sample Collection Updated"}.to_json

puts res.body
Request Response
  "success": true,
  "collectionID": "<COLLECTION_ID>",
  "data": {
    "name": "Sample Collection Updated"
401 / 404 / 422
  "message": "<ERROR_MESSAGE>",
  "success": false
Invalid Schema Doc ID Provided
Status Code Error Message
422 Unprocessible Entity
Expected content type - application/json

Fix: You need to pass Content-Type: application/json in the headers.

401 Unauthorized
Need to provide a secret-key to UPDATE Collections

Fix: While Updating a Collection, you need to pass secret-key header to update the Collection.

422 Unauthorized
Invalid Collection ID

Fix: You need to pass a valid Collection ID in-order to Update a Collection.

422 Unprocessible Entity
You need to provide a name.

Fix: You need to pass name key in the JSON Body of the Request with a Valid Name.

422 Unprocessible Entity
Name key cannot be blank.

Fix: Ensure that you provide some name to the collection.

422 Unprocessible Entity
Collection Name length should be more than 2 characters and less than 33 characters

Fix: Error message says it all :)

404 Not Found
Collection not found

Fix: Ensure that you are passing a valid Collection ID

401 Unauthorized
Invalid secret key provided.

Fix: If you are trying to Update a Collection, ensure that the secret-key you are passing in the header is correct.

422 Unauthorized
Need to pass true for remove-schema-id header

Fix: When you pass the remove-schema-id header to detach the Schema from the Collection, ensure that you pass the value of true

422 Unprocessible Entity
Schema Document not found

Fix: You need to pass the correct Schema Doc ID