Update an item

curl --request PATCH \
  --url https://api.cactal.ai/v1/cms/items/{itemId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.cactal.ai/v1/cms/items/{itemId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.cactal.ai/v1/cms/items/{itemId}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "slug": "<string>",
  "position": "<string>"
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

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}

Update an item

curl --request PATCH \
  --url https://api.cactal.ai/v1/cms/items/{itemId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.cactal.ai/v1/cms/items/{itemId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.cactal.ai/v1/cms/items/{itemId}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "slug": "<string>",
  "position": "<string>"
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

{
  "kind": "validation",
  "message": "<string>",
  "suggestion": "<string>",
  "validValues": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Path Parameters

itemId

string

required

Minimum string length: 1

Body

application/json

slug

string

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

Pattern: ^[a-z0-9][a-z0-9-]{0,255}$

data

object

Show child attributes

references

object

Show child attributes

images

object

Show child attributes

files

object

Show child attributes

position

enum<string>

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.

Available options:

before,

after,

first,

last

anchorItemId

string

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

Minimum string length: 1

Response

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

string

required

Id of the updated item.

slug

string

required

Slug of the item after the update.

position

string

required

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

Getting started

Documentation

Feedback

Websites

Website editors

API keys

Source code

Publishing

CMS collections

CMS fields

CMS items

Domains

Assets

Project context

Analytics

Organizations

Audit log

Billing

Update an item

Authorizations

Path Parameters

Body

Response