Create Collection

Create a collection of products. Call this in the same turn they ask for a new collection. Pass title. productIDs must already exist. mode manual uses those products. mode dynamic uses filters and ignores productIDs. Do not invent imageID. It is visible unless hiddenFromBrowse is true. Returns id and editorPath. App connections need the booking:write or inventory:write scope.

POST

/api/v1/collection

API referenceCollection

Create Collection

POST

/api/v1/collection

POST

/collection

curl -X POST "https://dash.lockii.app/api/v1/collection" \
  -H "x-api-key: $LOCKII_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string"
}'

Authorization

x-api-key
string
header
API key from Settings → Integrations → API.
Authorization
string
header
The same API key, or an OAuth access token, sent as Authorization: Bearer.
api_key
string
query
API key query parameter.

Body

application/json

description
string
Renter-facing description as plain text. Omit to leave it unchanged.
filters
object
Dynamic filters: category, location, price, and availability. Omit to leave filters unchanged.
hiddenFromBrowse
boolean
True hides the collection from the website. False shows it. Omit to leave it unchanged.
imageID
string
Existing image id. Omit when you do not have one. Do not invent an id.
mode
enum<string>
manual includes only productIDs. dynamic includes products that match filters. dynamic ignores productIDs.
One of:
dynamic
manual
productIDs
string[]
Product ids from search_products or readWebsite, in display order. On update this replaces the manual list. Do not invent ids.
slug
string
Public URL segment. Omit to generate one from the title.
title
string
required
Collection title

Response

application/json

JSON result for this operation.

object

{}