Create a collection

curl --request POST \
  --url https://api.cactal.ai/v1/cms/collections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "websiteId": "<string>",
  "slug": "<string>",
  "displayName": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({websiteId: '<string>', slug: '<string>', displayName: '<string>'})
};

fetch('https://api.cactal.ai/v1/cms/collections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.cactal.ai/v1/cms/collections"

payload = {
    "websiteId": "<string>",
    "slug": "<string>",
    "displayName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "collection": {
    "id": "<string>",
    "websiteId": "<string>",
    "slug": "<string>",
    "displayName": "<string>",
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "fields": [
    {
      "id": "<string>",
      "collectionId": "<string>",
      "key": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "type": "plain_text",
      "required": true,
      "isUnique": true,
      "position": "<string>",
      "example": "<unknown>",
      "config": {
        "choices": [
          {
            "id": "<string>",
            "label": "<string>"
          }
        ],
        "multiple": true
      },
      "targetCollectionId": "<string>"
    }
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

CMS collections

Create a collection

Creates a collection in the website’s CMS. slug uses lowercase letters, digits, and hyphens (max 64 characters, starting with a letter) and must be unique among the website’s active collections; displayName is 1–200 characters and description up to 2,000. Optionally pass fields (up to 100, same shape as the create-field body) to define the schema in the same call. A website can hold at most 100 active collections; the limit is enforced with a conflict error.

POST

cms

collections

Create a collection

curl --request POST \
  --url https://api.cactal.ai/v1/cms/collections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "websiteId": "<string>",
  "slug": "<string>",
  "displayName": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({websiteId: '<string>', slug: '<string>', displayName: '<string>'})
};

fetch('https://api.cactal.ai/v1/cms/collections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.cactal.ai/v1/cms/collections"

payload = {
    "websiteId": "<string>",
    "slug": "<string>",
    "displayName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "collection": {
    "id": "<string>",
    "websiteId": "<string>",
    "slug": "<string>",
    "displayName": "<string>",
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "fields": [
    {
      "id": "<string>",
      "collectionId": "<string>",
      "key": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "type": "plain_text",
      "required": true,
      "isUnique": true,
      "position": "<string>",
      "example": "<unknown>",
      "config": {
        "choices": [
          {
            "id": "<string>",
            "label": "<string>"
          }
        ],
        "multiple": true
      },
      "targetCollectionId": "<string>"
    }
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Body

application/json

websiteId

string

required

Minimum string length: 1

slug

string

required

Pattern: ^[a-z][a-z0-9-]{0,63}$

displayName

string

required

Required string length: 1 - 200

description

string | null

Maximum string length: 2000

fields

object[]

Maximum array length: 100

Show child attributes

Response

The created collection and its fields.

collection

object

required

Show child attributes

fields

object[]

required

The fields defining the shape of every item in the collection, in display order.

Show child attributes

Getting started

Documentation

Feedback

Websites

Website editors

API keys

Source code

Publishing

CMS collections

CMS fields

CMS items

Domains

Assets

Project context

Analytics

Organizations

Audit log

Billing

Create a collection

Authorizations

Body

Response