Skip to main content
PATCH
/
physical_samples
/
{physical_sample_id}
curl -X PATCH "https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "GaAs-003-revised"
  }'

{
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "name": "GaAs-003-revised",
  "created_datetime": "2024-01-15T11:00:00Z",
  "last_updated": "2024-01-16T09:30:00Z",
  "version": "0.269.1",
  "user_id": "user_abc123",
  "growth_instrument_id": null,
  "sample_id": null,
  "detail_notes_id": null,
  "physical_sample_metadata": {}
}
Updates a physical sample record. Only the fields you include in the body are changed.
​
physical_sample_id
string
required
UUID of the physical sample to update
​
name
string
Name or label for the sample
​
sample_id
integer
Numeric sample identifier
​
detail_notes_id
string
UUID of the detail note to link to this sample
​
physical_sample_metadata
object
Arbitrary key-value metadata for the sample

​
Response

​
id
string
Physical sample UUID
​
name
string
Sample name
​
created_datetime
string
ISO 8601 timestamp of creation
​
last_updated
string
ISO 8601 timestamp of last update
​
version
string
Version string of the sample record
​
user_id
string
ID of the user who owns the sample
​
growth_instrument_id
integer
Growth instrument ID, or null if not set
​
sample_id
integer
Numeric sample identifier, or null if not set
​
detail_notes_id
string
UUID of the linked detail note, or null if not set
​
physical_sample_metadata
object
Key-value metadata for the sample
curl -X PATCH "https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "GaAs-003-revised"
  }'

{
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "name": "GaAs-003-revised",
  "created_datetime": "2024-01-15T11:00:00Z",
  "last_updated": "2024-01-16T09:30:00Z",
  "version": "0.269.1",
  "user_id": "user_abc123",
  "growth_instrument_id": null,
  "sample_id": null,
  "detail_notes_id": null,
  "physical_sample_metadata": {}
}