Delete batch

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

Access

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

Endpoint

DELETE/v2/batches/{number}

Authorization

AuthorizationBearer <token>

API key for authentication. Use format: Bearer YOUR_API_KEY

In: header

Path Parameters

numberstring

Response Body

from tofupilot.v2 import TofuPilot

# Initialize the TofuPilot client
client = TofuPilot()

# Execute the operation
result = client.batches.delete(
    number="string"
)

# Handle response
print(result)

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

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

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

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

How is this guide?