CHchannel3-ai
collections

Create Collection

Changed on

Create a collection. Clauses are optional so an empty collection can be curated later.

Invalid brand_ids, category_ids, or website_ids return 422.

post/v1/collections

Request

  • Base URL
    https://api.trychannel3.com
  • URL
    https://api.trychannel3.com/v1/collections
  • Auth
    API key in header x-api-key

Request body

namestring nullable

Display name. Defaults to 'Collection {n}' for this account or user.

descriptionstring nullable

Optional vendor-facing notes for this collection.

user_idstring nullable

Optional partner user id. Scopes the collection to one end user and serves as the default x-user-id on collection-scoped search, browse, and conversation requests when the caller omits that header.

Response

Successful Response

collection_idstring required
namestring required
descriptionstring nullable
user_idstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes