Skip to content

Document the support ticket endpoints - #2726

Merged
AlexCatarino merged 1 commit into
QuantConnect:masterfrom
AlexCatarino:document-support-ticket-endpoints
Sep 29, 2026
Merged

AlexCatarino merged 1 commit into
QuantConnect:masterfrom
AlexCatarino:document-support-ticket-endpoints

Conversation

@AlexCatarino

@AlexCatarino AlexCatarino commented Sep 29, 2026 •

Copy link
Copy Markdown
Member

Adds /organizations/support/tickets/create, /list, and /read to the API reference under a new Support section.

  • create opens a ticket, or comments on one when you pass its hash. Attachments (project, backtest, live deployment, AI conversation) only apply to new tickets; the API ignores them on comments. Attaching any of them gives Support Staff permission to view the project.
  • list returns each ticket's data.external_id, the Id to mention to Support, and the ticket quota. The quota counts the tickets a member opened in a 1-month rolling window, open or closed.
  • The Support page Features section gets an API Support entry linking to the new pages, and Bug Reports now points historical data issues to the Data Issues page.

Test plan

  • Ran the example against the live API: opened, listed, read, commented on, and closed test tickets, including one with an AI conversation attached.
  • Commented on an existing ticket with a project and backtest; they weren't attached.
  • Checked allowance - remaining against the tickets opened in the last month.

@AlexCatarino
AlexCatarino force-pushed the document-support-ticket-endpoints branch 5 times, most recently from 7d61f21 to c8e363b Compare September 29, 2026 20:27
Add /organizations/support/tickets/create, /list, and /read to the OpenAPI
spec and generate their pages under a new Support section of the API
reference. The create endpoint opens a ticket or comments on one; only new
tickets take attachments. The quota counts the tickets a member opened in the
last 30 days, and the example checks it before it opens a ticket.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@AlexCatarino
AlexCatarino force-pushed the document-support-ticket-endpoints branch from c8e363b to 70842d3 Compare September 29, 2026 20:29
@AlexCatarino
AlexCatarino merged commit daaeb53 into QuantConnect:master Sep 29, 2026
1 check passed
@AlexCatarino
AlexCatarino deleted the document-support-ticket-endpoints branch September 29, 2026 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant