Update Single Item | Webflow Developer Documentation

curl -X PATCH "https://api.webflow.com/v2/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?skipInvalidFiles=true" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "isArchived": false,
  "isDraft": false,
  "fieldData": {
    "name": "The Hitchhiker'\''s Guide to the Galaxy",
    "slug": "hitchhikers-guide-to-the-galaxy",
    "plain-text": "Don'\''t Panic.",
    "rich-text": "<h3>A Guide to Interstellar Travel</h3><p>A towel is about the most massively useful thing an interstellar hitchhiker can have. <strong>Don'\''t forget yours!</strong></p>",
    "main-image": {
      "fileId": "62b720ef280c7a7a3be8cabe",
      "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
    },
    "image-gallery": [
      {
        "fileId": "62b720ef280c7a7a3be8cabd",
        "url": "/files/62b720ef280c7a7a3be8cabd_image.png"
      },
      {
        "fileId": "62b720ef280c7a7a3be8cabe",
        "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
      }
    ],
    "intro-video": "https://www.youtube.com/watch?v=aJ83KAggd-4",
    "official-site": "https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy",
    "contact-email": "zaphod.beeblebrox@heartofgold.gov",
    "support-phone": "424-242-4242",
    "answer-to-everything": 42,
    "release-date": "1979-10-12T00:00:00.000Z",
    "is-featured": true,
    "brand-color": "#000000",
    "category": "62b720ef280c7a7a3be8cabf",
    "author": "62b720ef280c7a7a3be8cab0",
    "tags": [
      "62b720ef280c7a7a3be8cab1",
      "62b720ef280c7a7a3be8cab2"
    ],
    "downloadable-asset": {
      "fileId": "62b720ef280c7a7a3be8cab3",
      "url": "/files/62b720ef280c7a7a3be8cab3_document.pdf"
    }
  }
}'

{
  "id": "42b720ef280c7a7a3be8cabe",
  "lastPublished": "2022-11-29T16:22:43.159Z",
  "lastUpdated": "2022-11-17T17:19:43.282Z",
  "createdOn": "2022-11-17T17:11:57.148Z",
  "fieldData": {
    "name": "The Hitchhiker's Guide to the Galaxy",
    "slug": "hitchhikers-guide-to-the-galaxy",
    "plain-text": "Don't Panic.",
    "rich-text": "<h3>A Guide to Interstellar Travel</h3><p>A towel is about the most massively useful thing an interstellar hitchhiker can have. <strong>Don't forget yours!</strong></p>",
    "main-image": {
      "fileId": "62b720ef280c7a7a3be8cabe",
      "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
    },
    "image-gallery": [
      {
        "fileId": "62b720ef280c7a7a3be8cabd",
        "url": "/files/62b720ef280c7a7a3be8cabd_image.png"
      },
      {
        "fileId": "62b720ef280c7a7a3be8cabe",
        "url": "/files/62b720ef280c7a7a3be8cabe_image.png"
      }
    ],
    "intro-video": "https://www.youtube.com/watch?v=aJ83KAggd-4",
    "official-site": "https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy",
    "contact-email": "zaphod.beeblebrox@heartofgold.gov",
    "support-phone": "424-242-4242",
    "answer-to-everything": 42,
    "release-date": "1979-10-12T00:00:00.000Z",
    "is-featured": true,
    "brand-color": "#000000",
    "category": "62b720ef280c7a7a3be8cabf",
    "author": "62b720ef280c7a7a3be8cab0",
    "tags": [
      "62b720ef280c7a7a3be8cab1",
      "62b720ef280c7a7a3be8cab2"
    ],
    "downloadable-asset": {
      "fileId": "62b720ef280c7a7a3be8cab3",
      "url": "/files/62b720ef280c7a7a3be8cab3_document.pdf"
    }
  },
  "cmsLocaleId": "653ad57de882f528b32e810e",
  "isArchived": false,
  "isDraft": false
}

Components in Rich Text

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 selected Item in a Collection.

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

<Tip title="Components in Rich Text"> 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. </Tip> Update a selected Item in a Collection. <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

item_idstringRequiredformat: "objectid"

Unique identifier for an Item

Query parameters

skipInvalidFilesbooleanOptionalDefaults to true

When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.

Request

Details of the item to update

cmsLocaleIdstringOptional

Identifier for the locale of the CMS item

isArchivedbooleanOptional

Boolean determining if the Item is set to archived

isDraftbooleanOptional

Sets the item’s draft state. The resulting status depends on whether the item has been published before:

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

Setting isDraft: true never unpublishes an item. To remove an item from the live site, use Unpublish Live Collection Items.

Sets the item's draft state. The resulting status depends on whether the item has been published before: - **Item that has never been published:** `isDraft: true` results in a `Draft` status. - **Already-published item:** `isDraft: true` results in a `Changes in draft` status. The live item stays published, and your changes are held back until you publish them. Setting `isDraft: true` never unpublishes an item. To remove an item from the live site, use [Unpublish Live Collection Items](/data/reference/cms/collection-items/live-items/delete-items-live).

fieldDataobjectOptional

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