Skip to main content
PATCH
/
v1
/
public
/
products
/
{product_id}
Update product
curl --request PATCH \
  --url https://api.poelis.com/v1/public/products/{product_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "readable_id": "<string>",
  "baseline_version_number": 2
}
'
{
  "archived": false,
  "baseline_version_number": 5,
  "createdBy": {
    "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
    "imageUrl": "https://example.com/avatar.png",
    "userName": "Jane Doe"
  },
  "excludedStatusIds": [],
  "id": "660e8400-e29b-41d4-a716-446655440000",
  "name": "Jet Engine Specifications",
  "owner": {
    "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
    "imageUrl": "https://example.com/avatar.png",
    "userName": "Jane Doe"
  },
  "readable_id": "jet-engine-specs",
  "status": {
    "color": "#3b82f6",
    "groupKey": "started",
    "id": "770e8400-e29b-41d4-a716-446655440999",
    "name": "In Progress"
  },
  "workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
product_id
string
required

Body

application/json

Request to update a product.

​
name
string | null

Product name

Minimum string length: 1
​
readable_id
string | null

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

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

Baseline version number (must be an existing product version)

Required range: x >= 1

Response

Updated product

Public representation of a product.

​
id
string
required
​
readable_id
string
required

Human-readable product ID

​
workspace_id
string
required

Workspace this product belongs to

​
name
string
required

Product name

​
baseline_version_number
integer | null

User-selected baseline product version number.

​
archived
boolean
default:false

Whether the product is archived or not.

​
status
PublicProductStatus · object

Current workflow status for this product. Null when no status is set.

​
excludedStatusIds
string[]

Workspace-level status IDs that are hidden for this product.

​
owner
PublicUser · object

Product owner. Null when not set.

Example:
{
  "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
  "imageUrl": "https://example.com/avatar.png",
  "userName": "Jane Doe"
}
​
createdBy
PublicUser · object

User who created the product.

Example:
{
  "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
  "imageUrl": "https://example.com/avatar.png",
  "userName": "Jane Doe"
}
​
createdAt
string | null

ISO 8601 creation timestamp

​
updatedAt
string | null

ISO 8601 last-update timestamp

​
updatedBy
PublicUser · object

User who last updated the product

Example:
{
  "id": "auth0|550e8400-e29b-41d4-a716-446655440000",
  "imageUrl": "https://example.com/avatar.png",
  "userName": "Jane Doe"
}