Skip to main content
PATCH
Update item

Authorizations

Authorization
string
header
required

Enter your API key. Example: Bearer poelis_api_...

Path Parameters

item_id
string
required

Body

application/json

Request to update an item.

name
string | null

Item name

Minimum string length: 1
description
string | null

Item description

part_number
string | null

Assign a part number when the draft item has none, or pass null to remove (retire) the current one. Must be unique within the organization.

readable_id
string | null

Human-readable item ID (must be unique within parent scope). Only lowercase letters, numbers and underscores are allowed.

Minimum string length: 1
Pattern: ^[a-z0-9_]+$
parent_item_id
string | null

Parent item ID for hierarchical structure

Response

Updated item

Public representation of an item.

id
string
required
readable_id
string
required

Human-readable item ID

product_id
string
required

Product this item belongs to

name
string
required

Item name

deleted
boolean
required

Whether the item is deleted

parent_item_id
string | null

Parent item ID for hierarchical structure

description
string | null

Item description

part_number
string | null

Active item part number, when assigned. Uniqueness is enforced organization-wide; format is validated when the product has rule configuration in the app.

draft_item_id
string | null

Draft item ID if this is a versioned item

createdBy
PublicUser · object | null

User who created the item

Example:
createdAt
string | null

ISO 8601 creation timestamp

updatedAt
string | null

ISO 8601 last-update timestamp

updatedBy
PublicUser · object | null

User who last updated the item

Example: