Update Collection Item(s) | Webflow Developer Documentation

curl -X PATCH https://api.webflow.com/beta/collections/580e63fc8c9a982ac9b8b745/items \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "items": [
    {
      "id": "66f6ed9576ddacf3149d5ea6",
      "cmsLocaleId": "66f6e966c9e1dc700a857ca5",
      "fieldData": {
        "name": "Ne Paniquez Pas",
        "slug": "ne-paniquez-pas",
        "featured": false
      }
    },
    {
      "id": "66f6ed9576ddacf3149d5ea6",
      "cmsLocaleId": "66f6e966c9e1dc700a857ca4",
      "fieldData": {
        "name": "No Entrar en Pánico",
        "slug": "no-entrar-en-panico",
        "featured": false
      }
    },
    {
      "id": "66f6ed9576ddacf3149d5eaa",
      "cmsLocaleId": "66f6e966c9e1dc700a857ca5",
      "fieldData": {
        "name": "Au Revoir et Merci pour Tous les Poissons",
        "slug": "au-revoir-et-merci",
        "featured": false
      }
    },
    {
      "id": "66f6ed9576ddacf3149d5eaa",
      "cmsLocaleId": "66f6e966c9e1dc700a857ca4",
      "fieldData": {
        "name": "Hasta Luego y Gracias por Todo el Pescado",
        "slug": "hasta-luego-y-gracias",
        "featured": false
      }
    }
  ]
}'

{
  "id": "580e64008c9a982ac9b8b754",
  "lastPublished": "2023-03-17T18:47:35.560Z",
  "lastUpdated": "2023-03-17T18:47:35.560Z",
  "createdOn": "2023-03-17T18:47:35.560Z",
  "fieldData": {
    "name": "My new item",
    "slug": "my-new-item",
    "date": "2022-11-18T00:00:00.000Z",
    "featured": false,
    "color": "#db4b68"
  },
  "items": [
    {
      "id": "66f6ed9576ddacf3149d5ea6",
      "lastPublished": "2024-09-27T17:38:29.066Z",
      "lastUpdated": "2024-09-27T17:38:29.066Z",
      "createdOn": "2024-09-27T17:38:29.066Z",
      "cmsLocaleId": "66f6e966c9e1dc700a857ca5",
      "isArchived": false,
      "isDraft": false,
      "fieldData": {
        "name": "Ne Paniquez Pas",
        "slug": "ne-paniquez-pas",
        "featured": false
      }
    },
    {
      "id": "66f6ed9576ddacf3149d5ea6",
      "lastPublished": "2024-09-27T17:38:29.066Z",
      "lastUpdated": "2024-09-27T17:38:29.066Z",
      "createdOn": "2024-09-27T17:38:29.066Z",
      "cmsLocaleId": "66f6e966c9e1dc700a857ca4",
      "isArchived": false,
      "isDraft": false,
      "fieldData": {
        "name": "No Entrar en Pánico",
        "slug": "no-entrar-en-panico",
        "featured": false
      }
    },
    {
      "id": "66f6ed9576ddacf3149d5eaa",
      "lastPublished": "2024-09-27T17:38:29.066Z",
      "lastUpdated": "2024-09-27T17:38:29.066Z",
      "createdOn": "2024-09-27T17:38:29.066Z",
      "cmsLocaleId": "66f6e966c9e1dc700a857ca5",
      "isArchived": false,
      "isDraft": false,
      "fieldData": {
        "name": "Au Revoir et Merci pour Tous les Poissons",
        "slug": "au-revoir-et-merci",
        "featured": false
      }
    },
    {
      "id": "66f6ed9576ddacf3149d5eaa",
      "lastPublished": "2024-09-27T17:38:29.066Z",
      "lastUpdated": "2024-09-27T17:38:29.066Z",
      "createdOn": "2024-09-27T17:38:29.066Z",
      "cmsLocaleId": "66f6e966c9e1dc700a857ca4",
      "isArchived": false,
      "isDraft": false,
      "fieldData": {
        "name": "Hasta Luego y Gracias por Todo el Pescado",
        "slug": "hasta-luego-y-gracias",
        "featured": false
      }
    }
  ],
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 4
  }
}

Components in Rich Text (beta)

Rich Text field values may contain Webflow component instances as <wf-component> markup. On read they appear inline in the field’s HTML; on write, the same markup creates or updates the instance.

Scalar props are prop-<propId>="…" attributes on the <wf-component>. Text and rich-text props are nested <wf-prop name="<propId>" type="text|richtext">…</wf-prop> children.

A write is rejected with a 400 if a component can’t be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale.

component-id and each prop-<propId> are specific to your site’s component definition — obtain them by listing your site’s components (GET /v2/sites/{site_id}/components, plus /components/{component_id}/properties for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit data-w-id when creating an instance (the server assigns it); keep it when updating one.

Update a single item or multiple items (up to 100) in a Collection.

Note: If the cmsLocaleId parameter is undefined or empty and the items are localized, items will be updated only in the primary locale.

Draft status behavior

isDraft: true doesn’t unpublish an item. The resulting status depends on whether the item has been published before:

Item that has never been published: the item gets a Draft status.
Already-published item: the item gets a Changes in draft status. The live item stays published, and your changes are held back until you publish them.

Setting isDraft: false queues the item to publish on the next site publish. To remove an item from the live site, use Unpublish Live Collection Items. For the full status mapping, see Publishing with the CMS API.

Required scope | CMS:write

<Note title="Components in Rich Text (beta)"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Note> Update a single item or multiple items (up to 100) in a Collection. **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale. <Note title="Draft status behavior"> `isDraft: true` doesn't unpublish an item. The resulting status depends on whether the item has been published before: - **Item that has never been published:** the item gets a `Draft` status. - **Already-published item:** the item gets a `Changes in draft` status. The live item stays published, and your changes are held back until you publish them. Setting `isDraft: false` queues the item to publish on the next site publish. To remove an item from the live site, use [Unpublish Live Collection Items](/data/reference/cms/collection-items/live-items/delete-items-live). For the full status mapping, see [Publishing with the CMS API](/data/docs/working-with-the-cms/publishing). </Note> Required scope | `CMS:write`

Authentication

AuthorizationBearer

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

Path parameters

collection_idstringRequiredformat: "objectid"

Unique identifier for a Collection

Request

Details of the item to update

itemslist of objectsOptional

Response

Request was successful

idstringRead-only

Unique identifier for the Item

lastPublishedstringRead-onlyformat: "date-string"

The date the item was last published

lastUpdatedstringRead-onlyformat: "date-string"

The date the item was last updated

createdOnstringRead-onlyformat: "date-string"

The date the item was created

fieldDataobject

cmsLocaleIdstringOptional

Identifier for the locale of the CMS item

isArchivedbooleanOptionalDefaults to false

Boolean determining if the Item is set to archived

isDraftbooleanOptionalDefaults to false

Whether the item is in a draft state. Together with lastPublished, this determines the status shown in the Webflow UI. See Publishing with the CMS API for the full mapping.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error