Update Single Collection Item | Webflow Developer Documentation

curl -X PATCH "https://api.webflow.com/beta/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 (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 type="text|richtext">…</wf-prop> children.

A write is rejected with a 400 if a component can’t be resolved, isn’t allowed in Rich Text (e.g. it contains a Slot or Collection List), 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.

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 type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, isn't allowed in Rich Text (e.g. it contains a Slot or Collection List), 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 selected Item in a Collection. 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

Boolean determining if the Item is set to draft

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

cmsLocaleIdstring

Identifier for the locale of the CMS item

isArchivedbooleanDefaults to false

Boolean determining if the Item is set to archived

isDraftbooleanDefaults to false

Boolean determining if the Item is set to draft

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

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 type="text|richtext">…</wf-prop> children.

Update a selected Item in a Collection.

Required scope | CMS:write