API Reference (v2)Batches

Update batch

Update a batch number. The current batch number is specified in the URL path with case-insensitive matching.

Access

API Key	Access Level	Description
User	Full	Users can update batchs
Station	Unauthorized	Stations cannot update batchs

Endpoint

PATCH/v2/batches/{number}

Authorization

AuthorizationBearer <token>

API key for authentication. Use format: Bearer YOUR_API_KEY

In: header

Path Parameters

numberstring

Current batch number to update.

Request Body

new_numberstring

New batch number.

Match^[a-zA-Z0-9_.:+-]+$

Length1 <= length <= 60

Response Body

from tofupilot.v2 import TofuPilot

# Initialize the TofuPilot client
client = TofuPilot()

# Execute the operation
result = client.batches.update(
    number="string",
    new_number="BATCH-2024-002"
)

# Handle response
print(result)

{
  "id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "message": "Unauthorized",
  "code": "UNAUTHORIZED",
  "issues": []
}

{
  "message": "Not found",
  "code": "NOT_FOUND",
  "issues": []
}

{
  "message": "Conflict",
  "code": "CONFLICT",
  "issues": []
}

{
  "message": "Internal server error",
  "code": "INTERNAL_SERVER_ERROR",
  "issues": []
}

How is this guide?

List and filter batches GET

Retrieve batches with associated units, serial numbers, and part revisions using cursor-based pagination.

Delete batch DELETE

Permanently delete a batch by number. Units associated with the batch will be disassociated but not deleted. No nested elements are removed.