Update product
Update a product’s metadata (name, description, readable_id, baseline_version_number).
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 a product.
Product name
1Product description
Assign a part number when the product has none, or pass null to remove (retire) the current one. In-place changes are not supported.
Human-readable product ID (must be unique within workspace). Only lowercase letters, numbers and underscores are allowed.
1^[a-z0-9_]+$Baseline version number (must be an existing product version)
x >= 1Response
Updated product
Public representation of a product.
Human-readable product ID
Workspace this product belongs to
Product name
Product description
Active product part number, when assigned. Uniqueness is enforced organization-wide; format is validated when the product has rule configuration in the app.
User-selected baseline product version number.
Whether the product is archived or not.
Current workflow status for this product. Null when no status is set.
Workspace-level status IDs that are hidden for this product.
Product owner. Null when not set.
User who created the product.
ISO 8601 creation timestamp
ISO 8601 last-update timestamp
User who last updated the product