Create Collection | Webflow Developer Documentation

curl -X POST https://api.webflow.com/v2/sites/580e63e98c9a982ac9b8b741/collections \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "displayName": "Blog Posts",
  "singularName": "Blog Post",
  "slug": "posts",
  "fields": [
    {
      "isRequired": true,
      "type": "PlainText",
      "displayName": "Title",
      "helpText": "The title of the blog post",
      "slug": "title"
    },
    {
      "isRequired": true,
      "type": "RichText",
      "displayName": "Content",
      "helpText": "The content of the blog post",
      "slug": "content"
    },
    {
      "isRequired": true,
      "type": "Reference",
      "displayName": "Author",
      "helpText": "The author of the blog post",
      "metadata": {
        "collectionId": "23cc2d952d4e4631ffd4345d2743db4e"
      },
      "slug": "author"
    }
  ]
}'

{
  "id": "562ac0395358780a1f5e6fbd",
  "displayName": "Blog Posts",
  "singularName": "Blog Post",
  "fields": [
    {
      "id": "string",
      "isRequired": true,
      "type": "PlainText",
      "displayName": "Title",
      "slug": "title",
      "helpText": "The title of the blog post"
    },
    {
      "id": "string",
      "isRequired": true,
      "type": "RichText",
      "displayName": "Content",
      "slug": "content",
      "helpText": "The content of the blog post"
    },
    {
      "id": "string",
      "isRequired": true,
      "type": "Reference",
      "displayName": "Author",
      "slug": "author",
      "helpText": "The author of the blog post",
      "metadata": {
        "collectionId": "23cc2d952d4e4631ffd4345d2743db4e"
      }
    }
  ],
  "slug": "posts",
  "createdOn": "2016-10-24T19:41:48Z",
  "lastUpdated": "2016-10-24T19:42:38Z"
}

Create a Collection for a site with collection fields.

Each collection includes the required name and slug fields, which are generated automatically. You can update the displayName of these fields, but the slug for them cannot be changed. Fields slugs are automatically converted to lowercase. Spaces in slugs are replaced with hyphens.

Required scope | cms:write

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"

Unique identifier for a Site

Request

Pass the Name of the collection, as well as the singular name of each item in the collection.

displayNamestringRequired

Name of the collection. Each collection name must be distinct.

singularNamestringRequired

Singular name of each item.

slugstringOptional

Part of a URL that identifier

fieldslist of objectsOptional

An array of custom fields to add to the collection

Response

Request was successful

idstringformat: "objectid"

Unique identifier for a Collection

displayNamestring

Name given to the Collection

singularNamestring

The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”)

fieldslist of objects

The list of fields in the Collection

slugstring

Slug of Collection in Site URL structure

createdOnstringRead-onlyformat: "date-time"

The date the collection was created

lastUpdatedstringRead-onlyformat: "date-time"

The date the collection was last updated

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error