CMS items

Update an item

Patches an item; omitted fields are left untouched. Keys in data are merged into the existing values and validated the same way as on create, while each key provided in references, images, or files replaces that field’s value wholesale — pass null (or [] for multi-valued fields) to clear an optional field. slug renames the item’s slug; slug and unique-field collisions fail with a conflict. Pass position: "first" or "last", or "before" / "after" together with anchorItemId, to move the item within the collection’s manual order — the default sort for item lists.

patch/cms/items/{itemId}

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/cms/items/{itemId}
  • Auth: HTTP bearer

Path parameters

itemIdstring required

Request body

slugstring

New slug for the item — a rename. Omit to keep the current slug. Must be unique among the collection’s active items.

dataobject
referencesobject
imagesobject
filesobject
position'before' | 'after' | 'first' | 'last'

Moves the item within the collection’s manual order — the default sort for item lists. Omit to leave the order unchanged. "before" / "after" require anchorItemId.

anchorItemIdstring

Sibling item to move against when position is "before" or "after".

Response

Identity and ordering key of the updated item. Read the full item back with the get-item endpoint.

idstring required

Id of the updated item.

slugstring required

Slug of the item after the update.

positionstring required

The item’s fractional ordering key after the update; changes when position is used. The default list order sorts by this value.

Changes

No recorded changes to this operation across all 1 revision of this API.