Update a product

Operation ID: updateAccountingProduct

Group: Accounting › Products

Open in the interactive reference

PATCH /accounting/products/{id}

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Updates a product with the fields you send. A field you leave out keeps its current value.

Use the product's id, not its productNumber or productCode.

An itemIds list you send replaces the whole list of linked inventory items, so include every item you want to keep.

You can't change the product's legal entity with this endpoint. If the request fails, the product is left unchanged.

The response is empty. Read the updated record with GET accounting/products/:id.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier of the product you want to update.

Request body

Required, application/json: updateAccountingProductInput.

Field Type Required Description
productName string no The product's display name.
productCode string no The product's code, unique within the tenant. A code another product already uses fails with DUPLICATE_PRODUCT_CODE.
effectiveStartDate date no The date the product becomes available. Use format YYYY-MM-DD.
effectiveEndDate date no The date the product is no longer available. Use format YYYY-MM-DD.
productFamily string no The product family. Accepted values: 'software', 'services', 'physicalProducts'.
productType string no The product type. Accepted values: 'sub', 'termLicense', 'support', 'professionalServices', 'training', 'usage', 'billableTravelExpense', 'bundle', 'hardwareConsumables', 'billablePassThrough', 'merchandise', 'shipping'.
description string no A description of the product shown to customers.
internalDescription string no A description of the product for internal use, not shown to customers.
crmProductId string no The product's identifier in an external CRM system.
isInventory boolean no Whether the product is tracked as inventory.
itemIds array<string> no The full set of inventory items linked to the product. This array replaces the whole set. Pass every item that should stay linked, and send an empty array to unlink every item. See id on GET inventory/items/:id. 
{
  "productName": "<productName>",
  "productCode": "<productCode>",
  "effectiveStartDate": "2026-01-15",
  "effectiveEndDate": "2026-01-15",
  "productFamily": "<productFamily>",
  "productType": "<productType>",
  "description": "<description>",
  "internalDescription": "<internalDescription>",
  "crmProductId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isInventory": true,
  "itemIds": [
    "<itemIds>"
  ]
}

Response

200 Success

{
  "data": {},
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
INVALID_ID 400
NOT_FOUND 400
DUPLICATE_PRODUCT_CODE 400
UNKNOWN_ITEM_IDS 400
VALIDATION_FAILED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses