Skip to main content
Update a material by ID

Path Parameters

material_id
string
required

Body

application/json

Model for updating an existing material. All fields are optional.

name
string | null

New name of the material

definition
Definition · object | null

New material definition

manufacturer
string | null

New manufacturer

product_id
string | null

New product ID

Response

Successful Response

Model representing a material as returned by the API.

name
string
required

Name of the material

id
string
required

Unique identifier for the material

organization_id
string
required

Organization ID of the material

created_at
string<date-time>
required

Timestamp when the material was created

updated_at
string<date-time>
required

Timestamp when the material was last updated

definition
Definition · object | null

Material definition (formula, type, constituents)

manufacturer
string | null

Manufacturer of the material

product_id
string | null

Supplier product ID

project_id
string | null

Project the material is scoped to, derived from the cell specification(s) that reference it. Null when the material is shared across multiple projects or is org-global.

property_count
integer
default:0

Number of property datasets attached to this material