Skip to main content
PATCH
Update Product
Updates fields on an existing product record.

Path parameters

  • id (string, required): The unique identifier of the product to update.

Conflict rules

If you modify the product’s code, it must not conflict with any other existing product code in your workspace.

Required permissions

Requires an API key with the crm:write scope.

Authorizations

x-api-key
string
header
required

Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.

Path Parameters

id
string
required

The unique identifier of the product

Body

application/json
name
string
Example:

"Annual Enterprise License v2"

code
string
Example:

"LIC-ENT-001"

category
string
Example:

"Software Subscriptions"

unit
string
Example:

"user/year"

unit_price
number
Example:

1400

custom_fields
object

Response

Product updated successfully

Standard envelope returned by POST, PATCH, PUT, and DELETE (mutation) endpoints

success
boolean
required
Example:

true

data
object
required

The created or updated entity

error
null
required
Example:

null