curl --request PATCH \
--url https://api.ionworks.com/cell_batches/{batch_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"notes": "<string>",
"date_manufactured": "2023-12-25",
"properties": {}
}
'import requests
url = "https://api.ionworks.com/cell_batches/{batch_id}"
payload = {
"name": "<string>",
"notes": "<string>",
"date_manufactured": "2023-12-25",
"properties": {}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
notes: '<string>',
date_manufactured: '2023-12-25',
properties: {}
})
};
fetch('https://api.ionworks.com/cell_batches/{batch_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ionworks.com/cell_batches/{batch_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'notes' => '<string>',
'date_manufactured' => '2023-12-25',
'properties' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/cell_batches/{batch_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"date_manufactured\": \"2023-12-25\",\n \"properties\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.ionworks.com/cell_batches/{batch_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"date_manufactured\": \"2023-12-25\",\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/cell_batches/{batch_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"date_manufactured\": \"2023-12-25\",\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"cell_specification_id": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"notes": "<string>",
"date_manufactured": "2023-12-25",
"properties": {},
"created_by": "<string>",
"instance_count": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Update a cell batch
Update a batch’s name, notes, manufacture date or properties.
Parameters
batch_id : str
Batch to update.
body : UpdateCellBatchBody
Fields to change. Omitted fields are left alone; an explicit null
clears notes, date_manufactured or properties.
Returns
CellBatch The updated batch.
curl --request PATCH \
--url https://api.ionworks.com/cell_batches/{batch_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"notes": "<string>",
"date_manufactured": "2023-12-25",
"properties": {}
}
'import requests
url = "https://api.ionworks.com/cell_batches/{batch_id}"
payload = {
"name": "<string>",
"notes": "<string>",
"date_manufactured": "2023-12-25",
"properties": {}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
notes: '<string>',
date_manufactured: '2023-12-25',
properties: {}
})
};
fetch('https://api.ionworks.com/cell_batches/{batch_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ionworks.com/cell_batches/{batch_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'notes' => '<string>',
'date_manufactured' => '2023-12-25',
'properties' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/cell_batches/{batch_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"date_manufactured\": \"2023-12-25\",\n \"properties\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.ionworks.com/cell_batches/{batch_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"date_manufactured\": \"2023-12-25\",\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/cell_batches/{batch_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"date_manufactured\": \"2023-12-25\",\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"cell_specification_id": "<string>",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"notes": "<string>",
"date_manufactured": "2023-12-25",
"properties": {},
"created_by": "<string>",
"instance_count": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Body
Request body for updating a cell batch.
All fields are optional (PATCH semantics); an explicit null clears a
nullable field, while omitting it leaves the stored value alone.
Response
Successful Response
A manufacturing lot of one cell specification, as returned by the API.
Unique identifier for the batch
ID of the organization that owns this batch
ID of the project that owns this batch
Cell specification this batch is a production run of
Lot name or number, unique (case-insensitively) per specification
When the batch was created
When the batch was last updated
Free-text notes about the batch
Manufacture date of the batch
Free-form lot metadata (datasheet lot number, QC results). Numeric values use the Quantity format.
User ID of the user who created this batch
Number of cell instances filed under this batch
Was this page helpful?