Backtest Management

Update Backtest

Introduction

Update a backtest name or note

Request

A JSON object containing info about the backtest and new name. The /backtests/update API accepts requests in the following format:

UpdateBacktestRequest Model - Request to update a backtest's name.
projectId integer
Project id for the backtest we want to update.
backtestId string
Backtest id we want to update.
name string
Name we'd like to assign to the backtest.
note string
Note attached to the backtest.
Example
{
  "projectId": 0,
  "backtestId": "string",
  "name": "string",
  "note": "string"
}

Responses

The /backtests/update API provides a response in the following format:

200 Success

RestResponse Model - Base API response class for the QuantConnect API.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example
{
  "success": true,
  "errors": [
    "string"
  ]
}

401 Authentication Error

UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: