SuperFunnel
SuperFunnel

CMS > Collections

Create a collection

Define a new collection schema with between 1 and 50 fields.

post/v1/cms/collections

Creates a collection. The name must be unique in the account — a duplicate returns 409.

Field IDs are generated, not chosen

Supply a label for each field and SuperFunnel derives the ID from it (Published at becomes published_at). A request that tries to set a field id is rejected with 400. Read the generated IDs from the response and key your entry values by those.

See the CMS overview for the available field types and the rules on group and select fields.

Request body

namestringrequired

Collection name. Must be unique within the account.

descriptionstring | null
fieldsobject[]required
Show 6 properties
labelstringrequired

Human-readable field name. SuperFunnel generates the field ID from it.

typeenumrequired

The field's data type.

One of: text, number, boolean, date, timestamp, url, asset, select, group

requiredboolean | null
repeatedboolean | null
optionsobject[] | null
Show 2 properties
labelstringrequired
valuestring | null
fieldsobject[] | null
Show 4 properties
labelstringrequired
typeenumrequired

One of: text, number, boolean, date, timestamp, url, asset, select, group

requiredboolean | null
optionsobject[] | null
Show 2 properties
labelstringrequired
valuestring | null
displayFieldIdstring | null
defaultSortobject | null
Show 2 properties
fieldIdstringrequired
directionenumrequired

One of: asc, desc

Response · 201

collectionobjectrequired
Show 9 properties
idstringrequired
namestringrequired
descriptionstring | nullrequired
fieldsobject[]required
Show 8 properties
idstringrequired
labelstringrequired
typeenumrequired

One of: text, number, boolean, date, timestamp, url, asset, select, group

requiredbooleanrequired
statusenumrequired

One of: active, deleted

optionsobject[] | nullrequired
Show 3 properties
valuestringrequired
labelstringrequired
statusenumrequired

One of: active, deleted

repeatedbooleanrequired
fieldsobject[] | nullrequired
Show 6 properties
idstringrequired
labelstringrequired
typeenumrequired

One of: text, number, boolean, date, timestamp, url, asset, select, group

requiredbooleanrequired
statusenumrequired

One of: active, deleted

optionsobject[] | nullrequired
displayFieldIdstring | nullrequired
defaultSortobject | nullrequired
Show 2 properties
fieldIdstringrequired
directionenumrequired

One of: asc, desc

statusenumrequired

One of: active, deleted

createdAtstringrequired
updatedAtstringrequired

Errors: 400, 401, 404, 405, 409, 429, 500. See Errors for the response shape.

postTry it
/v1/cms/collections

Stored in this browser tab only. Requests go directly to the API — the token never reaches the docs site.

Add a token to send a request.

https://api.superfunnel.ai/v1/cms/collections

curl -X POST 'https://api.superfunnel.ai/v1/cms/collections' \
  -H 'x-api-key: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Articles","description":"Articles published on the website","fields":[{"label":"Title","type":"text","required":true},{"label":"Category","type":"select","options":[{"value":"product","label":"Product"},{"value":"company","label":"Company"}]},{"label":"Published at","type":"timestamp"}],"displayFieldId":"title","defaultSort":{"fieldId":"published_at","direction":"desc"}}'