API ReferenceMaterials

Update Material

Updates one or more fields on an existing material. Only fields included in the request body are modified; omitted fields are left unchanged.

Requires scope: materials:write

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Material ID.

Request

This endpoint expects an object.
namestringOptional
Updated display name. Maximum 500 characters.
itemNumberstringOptional

Updated item/SKU number. Maximum 255 characters.

brandstringOptional
Updated brand name. Maximum 255 characters.
manufacturerstringOptional
Updated manufacturer name. Maximum 255 characters.
descriptionstringOptional

Updated description. Pass null to clear.

serializedbooleanOptional
Updated serialization flag.
activebooleanOptional

Set to false to deactivate the material.

categoryNameslist of stringsOptional
Replacement list of category names. Replaces all existing category assignments.
tagNameslist of stringsOptional
Replacement list of tag names. Replaces all existing tag assignments.

Response

This endpoint returns an object.
idUUID
Unique identifier for the material.
namestring
Display name of the material.
activeboolean
Whether the material is currently active in the catalog.
serializedboolean
Whether individual units of this material are tracked by serial number.
categorieslist of strings
List of category names assigned to this material.
tagslist of strings
List of tag names assigned to this material.
createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.
itemNumberstring

Item/SKU number for the material.

brandstring
Brand of the material.
manufacturerstring
Manufacturer of the material.
descriptionstring
Detailed description of the material.
materialTypeenum
Classification of the material.
measurementUnitstring

Unit of measurement (e.g. EA, FT, LB).

costForBusinessdouble

Internal business cost price in USD, taken from the material’s default variation (“Single”/“Standard”), or its oldest variation when no default exists. Null when the material has no variations.

costForClientdouble

Client-facing cost price in USD, taken from the material’s default variation (“Single”/“Standard”), or its oldest variation when no default exists. Null when the material has no variations.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error