Update item
Update an item’s metadata (name, description, readable_id, parent_item_id).
Only draft items can be updated. Only fields provided in the request will be updated.
Part numbers
part_number supports assign/remove only: pass a string to assign when empty, or null
to remove (retire) the current one. Changing to a different string without removing first
returns 422 (PART_NUMBER_ALREADY_ASSIGNED).
Authorizations
Enter your API key. Example: Bearer poelis_api_...
Path Parameters
Body
Request to update an item.
Item name
1Item description
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.
Human-readable item ID (must be unique within parent scope). Only lowercase letters, numbers and underscores are allowed.
1^[a-z0-9_]+$Parent item ID for hierarchical structure
Response
Updated item
Public representation of an item.
Human-readable item ID
Product this item belongs to
Item name
Whether the item is deleted
Parent item ID for hierarchical structure
Item description
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 if this is a versioned item
User who created the item
ISO 8601 creation timestamp
ISO 8601 last-update timestamp
User who last updated the item