Skip to content

Document the support ticket endpoints #2726

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexCatarino merged 1 commit into from
Sep 29, 2026
Merged

Document the support ticket endpoints #2726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
191 changes: 91 additions & 100 deletions 01 Cloud Platform/04 Organizations/05 Support/02 Features.php
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions 01 Cloud Platform/99 API Reference/00.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"12" : "Read account information",
"13" : "Read LEAN engine version",
"15" : "Report and list data issues",
"16" : "Open, comment on, and read support tickets",
"99" : "Examples of using the API with Jupyter Notebooks"
}
}
5 changes: 5 additions & 0 deletions 01 Cloud Platform/99 API Reference/16 Support/01 Create Support Ticket/01 Introduction.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- Code generated by API-Reference-Code-Generator.py -->

<p>
Open a new support ticket or comment on an existing ticket.
</p>
5 changes: 5 additions & 0 deletions 01 Cloud Platform/99 API Reference/16 Support/01 Create Support Ticket/02 Description.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- Code generated by API-Reference-Code-Generator.py -->

<p>
To open a new ticket, provide the <code>subject</code> and <code>message</code> properties. Each new ticket uses one ticket from the <a href="/docs/v2/cloud-platform/organizations/support#10-Ticket-Quotas">quota</a> of your support seat. To update an existing ticket with a comment, provide the <code>hash</code> of the ticket and the <code>message</code>. A comment on a closed ticket opens the ticket again, unless you set <code>close</code> to true. You can attach a project, backtest, live deployment, or AI conversation only when you open a new ticket. When you attach any of them, you give the QuantConnect Support Staff permission to view your project and all its libraries. When you comment on a ticket, the endpoint ignores these properties. You must have a <a href="/docs/v2/cloud-platform/organizations/support#04-Add-Seats">support seat</a> in the organization to use this endpoint.
</p>
56 changes: 56 additions & 0 deletions 01 Cloud Platform/99 API Reference/16 Support/01 Create Support Ticket/03 Request.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<!-- Code generated by API-Reference-Code-Generator.py -->
<p>
The organization, the ticket to comment on or the subject of a new ticket, and the message. The <code>/organizations/support/tickets/create</code> API accepts requests in the following format:
</p>
<table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>CreateSupportTicketRequest</code> Model - Request body to open a support ticket or comment on a ticket.</th>
</tr>
</thead>
<tr>
<td width="20%">organizationId</td> <td> <code>string<br/><i><sub>required</sub></i><br/><i><sub>example: 5cad178b20a1d52567b534553413b691</sub></i></code> <br/> Id of the organization.</td>
</tr>
<tr>
<td width="20%">subject</td> <td> <code>string<br/><i><sub>example: Live algorithm stopped after a brokerage disconnection</sub></i></code> <br/> Subject of the new ticket. Required to open a new ticket.</td>
</tr>
<tr>
<td width="20%">message</td> <td> <code>string<br/><i><sub>required</sub></i><br/><i><sub>example: My live algorithm stopped at 10:32 ET after the brokerage disconnected.</sub></i></code> <br/> HTML body of the message.</td>
</tr>
<tr>
<td width="20%">hash</td> <td> <code>string</code> <br/> Id of the ticket to comment on. To open a new ticket, omit this property.</td>
</tr>
<tr>
<td width="20%">close</td> <td> <code>boolean</code> <br/> If true, close the ticket after you add the comment. Requires <code>hash</code>.</td>
</tr>
<tr>
<td width="20%">projectId</td> <td> <code>integer</code> <br/> Optional. Id of one of your projects to attach to the new ticket. To get your project Ids, use the <code>/projects/read</code> endpoint.</td>
</tr>
<tr>
<td width="20%">backtestId</td> <td> <code>string</code> <br/> Optional. Id of a backtest of the attached project to attach to the new ticket. Requires <code>projectId</code>. To get the backtest Ids of a project, use the <code>/backtests/list</code> endpoint.</td>
</tr>
<tr>
<td width="20%">deployId</td> <td> <code>string</code> <br/> Optional. Id of a stopped live deployment of the attached project to attach to the new ticket. Requires <code>projectId</code>. To get the deployment Ids of a project, use the <code>/live/list</code> endpoint.</td>
</tr>
<tr>
<td width="20%">agentDeploymentId</td> <td> <code>string</code> <br/> Optional. Id of an AI conversation of the attached project to attach to the new ticket. Requires <code>projectId</code>. To get the conversation Ids of a project, use the <code>/agents/deployments/list</code> endpoint.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"organizationId": "5cad178b20a1d52567b534553413b691",
"subject": "Live algorithm stopped after a brokerage disconnection",
"message": "My live algorithm stopped at 10:32 ET after the brokerage disconnected.",
"hash": "string",
"close": true,
"projectId": 0,
"backtestId": "string",
"deployId": "string",
"agentDeploymentId": "string"
}</pre>
</div>
</td>
</tr>
</table>
46 changes: 46 additions & 0 deletions 01 Cloud Platform/99 API Reference/16 Support/01 Create Support Ticket/04 Responses.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<!-- Code generated by API-Reference-Code-Generator.py -->

<p>
The <code>/organizations/support/tickets/create</code> API provides a response in the following format:
</p>
<h4>200 Success</h4>
<table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>CreateSupportTicketResponse</code> Model - Response from opening a support ticket or commenting on a ticket.</th>
</tr>
</thead>
<tr>
<td width="20%">hash</td> <td> <code>string</code> <br/> Id of the ticket.</td>
</tr>
<tr>
<td width="20%">success</td> <td> <code>boolean</code> <br/> Indicate if the API request was successful.</td>
</tr>
<tr>
<td width="20%">errors</td> <td> <code>string Array</code> <br/> List of errors with the API call.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"hash": "string",
"success": true,
"errors": [
"string"
]
}</pre>
</div>
</td>
</tr>
</table><h4>401 Authentication Error</h4>
<table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>UnauthorizedError</code> Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.</th>
</tr>
</thead>
<tr>
<td width="20%">www_authenticate</td> <td> <code>string</code> <br/> Header</td>
</tr>
</table>
1 change: 1 addition & 0 deletions 01 Cloud Platform/99 API Reference/16 Support/01 Create Support Ticket/99 Examples.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<? include(DOCS_RESOURCES."/qc-api/examples/support.php");?>
5 changes: 5 additions & 0 deletions 01 Cloud Platform/99 API Reference/16 Support/02 List Support Tickets/01 Introduction.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- Code generated by API-Reference-Code-Generator.py -->

<p>
List the support tickets of an organization.
</p>
5 changes: 5 additions & 0 deletions 01 Cloud Platform/99 API Reference/16 Support/02 List Support Tickets/02 Description.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- Code generated by API-Reference-Code-Generator.py -->

<p>
The response contains all the open tickets and one page of 10 closed tickets. Use the <code>closedPage</code> property to select the page of closed tickets and the <code>totalClosed</code> property of the response to get the number of closed tickets.
</p>
28 changes: 28 additions & 0 deletions 01 Cloud Platform/99 API Reference/16 Support/02 List Support Tickets/03 Request.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- Code generated by API-Reference-Code-Generator.py -->
<p>
The organization and the page of closed tickets to list. The <code>/organizations/support/tickets/list</code> API accepts requests in the following format:
</p>
<table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>ListSupportTicketsRequest</code> Model - Request body to list the support tickets of an organization.</th>
</tr>
</thead>
<tr>
<td width="20%">organizationId</td> <td> <code>string<br/><i><sub>required</sub></i><br/><i><sub>example: 5cad178b20a1d52567b534553413b691</sub></i></code> <br/> Id of the organization.</td>
</tr>
<tr>
<td width="20%">closedPage</td> <td> <code>integer<br/><i><sub>example: 0</sub></i></code> <br/> Index of the page of closed tickets to return, starting at 0. Each page contains 10 tickets. The default value is 0.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"organizationId": "5cad178b20a1d52567b534553413b691",
"closedPage": 0
}</pre>
</div>
</td>
</tr>
</table>
Loading
Loading