Skip to main content
Update a material by ID
curl --request PATCH \
  --url https://api.ionworks.com/materials/{material_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "definition": {},
  "manufacturer": "<string>",
  "product_id": "<string>"
}
'
{
  "name": "<string>",
  "id": "<string>",
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "definition": {},
  "manufacturer": "<string>",
  "product_id": "<string>",
  "property_count": 0
}

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

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

Material definition (formula, type, constituents)

manufacturer
string | null

Manufacturer of the material

product_id
string | null

Supplier product ID

property_count
integer
default:0

Number of property datasets attached to this material