Skip to content
CM Box Documentation

Update an item in a package

PUT
/api/items/{configId}/_package/{packageName}/{itemId}
curl --request PUT \
  --url https://example.com/api/items/example/_package/example/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "My Updated Document", "description": "example", "slug": "my-document", "status": "draft", "taxonomies": [ { "id": "example", "name": "example", "categories": [] } ], "parent": "example", "readPerm": [ "example" ], "writePerm": [ "example" ], "deletePerm": [ "example" ], "fields": { "additionalProperty": "example" }, "makeCurrent": true, "publish": true, "archive": true, "skipWorkflow": false }'

Updates a content item within an update package. Supports JSON and multipart/form-data.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
configId
required

Repository configuration ID

string
packageName
required

Package name

string
itemId
required

Item ID

string

Request Body

Section titled “Request Body”
Media typeapplication/json
object
name

Item name

string
Example
My Updated Document
description

Item description

string
slug

URL slug

string
Example
my-document
status

Publication status

string
Allowed values: draft published archived
taxonomies

Taxonomy/category assignments

Array<object>
object
id
required

Taxonomy ID

string
name
required

Taxonomy name

string
categories

Selected categories within this taxonomy

Array<object>
default:
object
id
required

Category ID

string
name
required

Category name

string
parent

Parent folder ID

string | null
readPerm

Roles with read permission

Array<string>
writePerm

Roles with write permission

Array<string>
deletePerm

Roles with delete permission

Array<string>
fields

Custom field values defined by the content type

object
key
additional properties
makeCurrent

Whether to make this item the current version

boolean
publish

Whether to publish the item

boolean
archive

Archive the item

boolean
skipWorkflow

Bypass strict auto-package rules and save directly to the main repository. Requires the content.skip_workflow permission for the item’s type.

boolean
Example
false

Responses

Section titled “Responses”

200

Section titled “200”

Item updated successfully

Media typeapplication/json
object
id
required

Unique item identifier

string
name
required

Item name

string
type
required

Content type name

string
description

Item description

string | null
slug
required

URL-friendly slug

string
slugSearch

Searchable slug variant

string
status
required

Publication status

string
Allowed values: draft published archived
taxonomies

Assigned taxonomies and categories

Array<object>
default:
object
id
required

Taxonomy ID

string
name
required

Taxonomy name

string
categories

Selected categories within this taxonomy

Array<object>
default:
object
id
required

Category ID

string
name
required

Category name

string
currentVersion
required

Current version number

string
latestVersion
required

Latest available version

string
isArchived
required

Whether item is archived

boolean
isPublished
required

Whether item is published

boolean
isPreview

Whether this is a preview version

boolean
isLatestVersion
required

Whether this is the latest version

boolean
isLatestPublished
required

Whether this is the latest published version

boolean
fileExtension

Primary file extension

string
createdDate
required

Creation timestamp (Unix ms)

number
updatedDate
required

Last update timestamp (Unix ms)

number
publishedDate

Publication timestamp (Unix ms)

number
readPerm

Roles with read permission

Array<string>
default:
writePerm

Roles with write permission

Array<string>
default:
deletePerm

Roles with delete permission

Array<string>
default:
createdByUser
required
object
userName
required

User’s username/login

string
displayName
required

User’s display name

string
email
required

User’s email address

string
updatedByUser
required
object
userName
required

User’s username/login

string
displayName
required

User’s display name

string
email
required

User’s email address

string
parent

Parent folder ID

string | null
cardPreview

HTML preview for card display

string
renditions

Available renditions/files

Array<object>
object
name
required

Rendition name

string
type
required

Rendition type

string
format

File format/extension

string
url
required

URL to access the rendition

string
storage

Storage details

object
objectName
required

Storage object name

string
version

Storage version ID

string | null
objectName

Object storage name

string
mimeType

MIME type

string
size

File size in bytes

number
fileName

Original file name

string
versionHistory

Version history

Array<object>
object
version
required
string
status
required
string
updatedDate
required
number
updatedByUser
required
object
userName
required

User’s username/login

string
displayName
required

User’s display name

string
email
required

User’s email address

string
Example
{
  "id": "CONT_ABC123",
  "name": "My Document",
  "type": "Article",
  "slug": "my-document",
  "status": "draft",
  "taxonomies": [],
  "currentVersion": "0.1",
  "latestVersion": "1.0",
  "fileExtension": "pdf",
  "createdDate": 1704067200000,
  "updatedDate": 1704153600000,
  "readPerm": [],
  "writePerm": [],
  "deletePerm": [],
  "createdByUser": {
    "userName": "user@example.com",
    "displayName": "John Doe",
    "email": "user@example.com"
  },
  "updatedByUser": {
    "userName": "user@example.com",
    "displayName": "John Doe",
    "email": "user@example.com"
  },
  "renditions": [
    {
      "name": "native",
      "type": "native",
      "format": "jpg",
      "url": "/api/assets/repo/item123/native",
      "mimeType": "image/jpeg",
      "size": 1024,
      "fileName": "image.jpg"
    }
  ],
  "versionHistory": [
    {
      "updatedByUser": {
        "userName": "user@example.com",
        "displayName": "John Doe",
        "email": "user@example.com"
      }
    }
  ]
}

400

Section titled “400”

Invalid request