SuperFunnel
SuperFunnel

CMS > Collections

Update a collection

Rename a collection, add fields, or change existing ones.

patch/v1/cms/collections/{collectionId}

Send at least one property. An empty body returns 400.

What cannot change

A field's ID, its type, its repeated setting, and the sub-fields of an existing group are fixed once created. You can change a label, toggle required, and append options to a select field.

Removing a field is a soft delete: it stays in the collection's history with a status of deleted so existing entries keep their schema. A collection must always keep at least one active field.

Path parameters

collectionIdstringrequired

ID of the collection.

Request body

namestring | null
descriptionstring | null
addFieldsobject[] | null
Show 6 properties
labelstringrequired
typeenumrequired

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
updateFieldsobject[] | null
Show 4 properties
fieldIdstringrequired
labelstring | null
requiredboolean | null
addOptionsobject[] | null
Show 2 properties
labelstringrequired
valuestring | null
removeFieldIdsstring[] | null
displayFieldIdstring | null
defaultSortobject | null
Show 2 properties
fieldIdstringrequired
directionenumrequired

One of: asc, desc

Response · 200

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.

patchTry it
/v1/cms/collections/{collectionId}

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

Path parameters

Add a token to send a request.

https://api.superfunnel.ai/v1/cms/collections/{collectionId}

curl -X PATCH 'https://api.superfunnel.ai/v1/cms/collections/{collectionId}' \
  -H 'x-api-key: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"description":"Product and company articles","addFields":[{"label":"Summary","type":"text"}],"updateFields":[{"fieldId":"category","label":"Topic","addOptions":[{"value":"guides","label":"Guides"}]}]}'