patch/products/{id}Write operation

Update a product

Use this operation to update a product. Only documented mutable fields are accepted; omitted fields retain their current values unless the request schema states replacement semantics. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Finance-protected fields are omitted or rejected unless the credential also has the documented finance scope.

Required scopes

products:write

Request example

curl --request PATCH \
  --url 'https://api.de.teamgrid.app/v1/products/ID' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": null,
    "annotation": null,
    "costCenter": null,
    "description": null,
    "disabled": null,
    "financeAccount": null,
    "name": "string",
    "priceGroupIds": null,
    "productGroupId": null,
    "productNumber": null,
    "purchasePrice": null,
    "retailPrice": null
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/products/ID', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "amount": null,
  "annotation": null,
  "costCenter": null,
  "description": null,
  "disabled": null,
  "financeAccount": null,
  "name": "string",
  "priceGroupIds": null,
  "productGroupId": null,
  "productNumber": null,
  "purchasePrice": null,
  "retailPrice": null
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/products/ID', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "amount": null,
  "annotation": null,
  "costCenter": null,
  "description": null,
  "disabled": null,
  "financeAccount": null,
  "name": "string",
  "priceGroupIds": null,
  "productGroupId": null,
  "productNumber": null,
  "purchasePrice": null,
  "retailPrice": null
}),
})

const result: ApiResponse = await response.json()

teamgrid products update \
  ID \
  --data @payload.json

Example response 2xx

{
  "data": {
    "attributes": {
      "amount": null,
      "annotation": "string",
      "archived": false,
      "costCenter": [
        "string"
      ],
      "createdAt": "2026-07-29T09:00:00.000Z",
      "description": "string",
      "disabled": false,
      "financeAccount": null,
      "name": "string",
      "priceGroupIds": [
        "string"
      ],
      "productGroupId": null,
      "productNumber": null
    },
    "id": "string",
    "type": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

idpath · required

JSON request bodyValid JSON

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Path parameters

idrequired

string

Stable identifier of the resource in the authenticated workspace.

Request body

application/json

amount

numbernullable

The amount associated with this product.

annotation

stringnullable

The annotation associated with this product.

costCenter

arraynullable

The cost center associated with this product.

description

stringnullable

Human-readable description of the resource.

disabled

booleannullable

Whether this resource is disabled for new use.

financeAccount

stringnullable

The finance account associated with this product.

name

string

Human-readable name of the resource.

priceGroupIds

arraynullable

Ordered set of price group identifiers associated with this product.

productGroupId

stringnullable

Identifier of the product group that contains this product.

productNumber

stringnullable

The product number associated with this product.

purchasePrice

numbernullable

Requires products:finance:write when supplied.

retailPrice

numbernullable

The retail price associated with this product.

taxRate

numbernullable

The tax rate associated with this product.

unit

stringnullable

The unit associated with this product.

Responses

200The request to update a product succeeded. The response contains the canonical public result and request metadata.application/json

Response schemaapplication/json

required

Product

Product catalog entry. purchasePrice is finance-gated.

required

ResponseMeta

Public API representation of meta.

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

404The tenant-scoped resource does not exist.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

409The request conflicts with the current resource state.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

502The cell-local application returned an invalid response.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDupdateProductOpenAPI JSON ↗

Documentation feedbackWas this page useful?