v2 Reference (Preview)/Procedures

Update procedure

Update a procedure's name. The procedure ID is specified in the URL path.

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 procedures they have permission to manage
Station	Unauthorized	Stations cannot update procedures

Endpoint

PATCH/v2/procedures/{id}

Authorization

AuthorizationBearer <token>

API key for authentication. Use format: Bearer YOUR_API_KEY

In: header

Path Parameters

idstring

Unique identifier of the procedure to update.

Formatuuid

Request Body

namestring

New name for the procedure.

Length1 <= length <= 60

Response Body

from tofupilot.v2 import TofuPilot

# Initialize the TofuPilot client
client = TofuPilot()

# Execute the operation
result = client.procedures.update(
    id="550e8400-e29b-41d4-a716-446655440000",
    name="Updated Battery Test Procedure"
)

# Handle response
print(result)

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

{
  "code": "BAD_REQUEST",
  "message": "Procedure name is required",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Procedure not found: {id}",
  "issues": []
}

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

How is this guide?

List and filter procedures GET

Retrieve procedures with optional filtering and search. Returns all procedure data including creator, recent runs, and FPY (First Pass Yield) statistics.

Delete procedure DELETE

Permanently delete a procedure and all associated data. This action cannot be undone and will remove all nested elements including runs, phases, measurements, and run attachments.