Update Collection

Update a Collection’s name or metadata

PUT /v1/apps/{app_id}/users/{user_id}/collections/{collection_id}

JavaScript

JavaScript

import Honcho from 'honcho-ai';

const client = new Honcho({
  apiKey: process.env['HONCHO_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const collection = await client.apps.users.collections.update('app_id', 'user_id', 'collection_id');

  console.log(collection.id);
}

main();

200

{
  "id": "<string>",
  "name": "<string>",
  "user_id": "<string>",
  "app_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

app_id · string · required

ID of the app

user_id · string · required

ID of the user

collection_id · string · required

ID of the collection to update

Body

application/json

Updated collection parameters

name · string | null

metadata · Metadata · object

Response

200

application/json

Successful Response

id · string · required

name · string · required

user_id · string · required

app_id · string · required

created_at · string<date-time> · required

metadata · Metadata · object