Skip to content
BuildWorkPro Docs

Update product

PATCH
/products/{id}
 
curl --request PATCH \
  --url https://app.buildworkpro.com/api/v1/products/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sku": "example", "name": "example", "description": "example", "salesDescription": "example", "type": "example", "categoryId": 1, "costPrice": "example", "sellPrice": "example", "unit": "example", "manufacturerId": 1, "manufacturerCode": "example", "isKit": true, "isActive": true, "buyTaxPercent": "example", "sellTaxPercent": "example" }'

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
integer

Header Parameters

Section titled “ Header Parameters ”
Idempotency-Key
string format: uuid
<= 255 characters

Idempotent retry key for mutating operations. The first request with a given key executes normally and BuildWorkPro caches the response. Replaying the same key with the same request body (method + path + JSON body, SHA-256 hashed) returns the cached response without re-executing the mutation. Replaying with a DIFFERENT body returns 409 idempotency_key_reused. The cache TTL is 24 hours; after expiry the key is treated as a new operation. Keys are tenant-scoped. Recommended: a fresh UUID v4 per logical operation.

Request Body

Section titled “ Request Body ”
Media type application/json
object
sku
string | null
<= 50 characters
name
string
<= 255 characters
description
string | null
salesDescription
string | null
type
string
<= 50 characters
categoryId
integer | null
>= -2147483648 <= 2147483647
costPrice
string | null
sellPrice
string | null
unit
string | null
<= 50 characters
manufacturerId
integer | null
>= -2147483648 <= 2147483647
manufacturerCode
string | null
<= 100 characters
isKit
boolean
isActive
boolean
buyTaxPercent
string | null
sellTaxPercent
string | null
Example generated 
{
  "sku": "example",
  "name": "example",
  "description": "example",
  "salesDescription": "example",
  "type": "example",
  "categoryId": 1,
  "costPrice": "example",
  "sellPrice": "example",
  "unit": "example",
  "manufacturerId": 1,
  "manufacturerCode": "example",
  "isKit": true,
  "isActive": true,
  "buyTaxPercent": "example",
  "sellTaxPercent": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Updated

Media type application/json
object
data
required
object
id
required
integer
sku
required
string
name
required
string
description
required
string | null
type
required
string
categoryId
required
integer | null
costPrice
required
string | null
sellPrice
required
string | null
unit
required
string | null
manufacturerId
required
integer | null
manufacturerCode
required
string | null
isKit
required
boolean
isActive
required
boolean
createdAt
required
Any of:
string format: date-time
updatedAt
required
Any of:
string format: date-time
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer
Example generated 
{
  "data": {
    "id": 1,
    "sku": "example",
    "name": "example",
    "description": "example",
    "type": "example",
    "categoryId": 1,
    "costPrice": "example",
    "sellPrice": "example",
    "unit": "example",
    "manufacturerId": 1,
    "manufacturerCode": "example",
    "isKit": true,
    "isActive": true,
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  },
  "meta": {
    "request_id": "example",
    "pagination": {
      "cursor": "example",
      "has_more": true,
      "count": 1
    }
  }
}

404

Section titled “ 404 ”

Error

Media type application/problem+json
object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string
Example generated 
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

409

Section titled “ 409 ”

Error

Media type application/problem+json
object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string
Example generated 
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

422

Section titled “ 422 ”

Error

Media type application/problem+json
object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string
Example generated 
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}