Skip to main content
PATCH
/
target-materials
/
{target_material_id}
curl -X PATCH "https://api.atomscale.ai/target-materials/42" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sample_name": "BaTiO3 on Si (revised)"
  }'

{
  "sample_id": 42,
  "sample_name": "BaTiO3 on Si (revised)",
  "substrate": "Si",
  "sample_metadata": {},
  "detail_notes_id": null,
  "user_id": "user_abc123",
  "version": "0.269.1",
  "last_updated": "2024-01-15T12:00:00Z"
}
Updates the sample-level details of a target material. All body fields are optional; only the fields you send are changed.
​
target_material_id
integer
required
ID of the target material to update
​
sample_name
string
New name for the target material sample
​
substrate
string
New substrate the layers are grown on
​
sample_id
integer
Reassign the target material to a different sample
​
sample_metadata
object
Replacement metadata for the sample

​
Response

​
sample_id
integer
ID of the target material sample
​
sample_name
string
Name of the target material sample
​
substrate
string
Substrate the layers are grown on
​
sample_metadata
object
Metadata attached to the sample
​
detail_notes_id
string
ID of the linked detail note, if any
​
user_id
string
ID of the user who owns the record
​
version
string
Schema version of the record
​
last_updated
string
ISO 8601 timestamp of the last update
curl -X PATCH "https://api.atomscale.ai/target-materials/42" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sample_name": "BaTiO3 on Si (revised)"
  }'

{
  "sample_id": 42,
  "sample_name": "BaTiO3 on Si (revised)",
  "substrate": "Si",
  "sample_metadata": {},
  "detail_notes_id": null,
  "user_id": "user_abc123",
  "version": "0.269.1",
  "last_updated": "2024-01-15T12:00:00Z"
}