v2 Reference (Preview)/Batches
Update batch
Update a batch number. The current batch number is specified in the URL path. Batch numbers are matched case-insensitively (e.g., "BATCH-001" and "batch-001" are considered the same).
API v2 Preview
The TofuPilot API v2.0 is currently in public preview and is subject to change as we stabilize until release (planned for Aug 2025).
Access
| API Key | Access Level | Description |
|---|---|---|
| User | Full | Users can update batches |
| Station | Unauthorized | Stations cannot update batches |
Endpoint
PATCH
/v2/batches/{number}AuthorizationBearer <token>
API key for authentication. Use format: Bearer YOUR_API_KEY
In: header
Path Parameters
numberstring
Current batch number to update.
Match
^[a-zA-Z0-9_.:+-]+$Length
1 <= length <= 60new_numberstring
New batch number.
Match
^[a-zA-Z0-9_.:+-]+$Length
1 <= length <= 60Response Body
from tofupilot.v2 import TofuPilot
# Initialize the TofuPilot client
client = TofuPilot()
# Execute the operation
result = client.batches.update(
number="BATCH-2024-001",
new_number="BATCH-2024-002"
)
# Handle response
print(result){
"id": "550e8400-e29b-41d4-a716-446655440000"
}{
"code": "NOT_FOUND",
"message": "Procedure not found: {id}",
"issues": []
}{
"code": "CONFLICT",
"message": "A version with this tag already exists for the procedure",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}How is this guide?