Support

Create support ticket

Creates a local SupportTicket record inside the organization selected by the bearer API key and owned by the synthetic public API actor selected by current authentication behavior.

POSTNeeds publication reviewCommunicationSupportoperationId: createSupportTickethttps://dev-api.quickintell.com/api/v1/support/tickets

Needs publication reviewCommunicationSupport

Route status

Needs publication review

The endpoint contract is visible, but QuickRCM has not approved it yet for normal production API use.

Publication status

Needs publication review

Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use. Also requires E2 side-effect policy before production recipes, SDK inclusion, or try-out access.

Authentication

Bearer API key declared

OpenAPI declares bearer API-key security for this operation.

Tenant context

API-key organization

API-key organization context is authoritative; request organizationId is not a public tenant selector.

Side-effect summary

Communication

May imply email, SMS, fax, phone, notices, support messages, or delivery workflow behavior.

Source artifact

docs/openapi/openapi.json

OpenAPI 3.1.0; API 1.0.0.

When to use this endpoint

Use this page as an internal baseline for the support contract generated for POST /api/v1/support/tickets. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Shows the generated OpenAPI shape for POST /api/v1/support/tickets, but keeps the route out of ordinary production API positioning until review is complete.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Mutating behavior still needs side-effect and retry evidence.

Not public from this page

Do not publish this endpoint as an ordinary developer API until its unresolved decisions are closed.

Headers and tenancy

Current headers and tenant authority. Target headers stay labeled as future until OpenAPI and release evidence declare them.

Header	Required	Current status	Notes
Authorization	Yes	Current	Bearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-Key	No	Target/future	Do not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-Id	No	Target/future	Use for support correlation only after approved; not declared as a standard OpenAPI header today.

Required scopes

Unclassified until E6 route metadata exists; do not infer scopes from route names.

Wrong-org behavior

Tenant-safe 404, empty list, or 403 is endpoint-specific and remains an evidence gap until E1 is closed.

Actor and audit

No public actor, audit, or correlation contract is published from OpenAPI alone.

Idempotency and retries

Retry behavior is documented conservatively because universal idempotency headers are not declared.

Topic	Status	Guidance
Current idempotency	No idempotency mechanism is declared.	Do not retry blindly. Check resource, status, batch, or job state before repeating the request.
Universal header	Not declared	Do not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behavior	Unresolved	Same-key changed-payload, in-flight retry, fingerprint scope, and TTL behavior remain endpoint-specific evidence gaps.

Async jobs and polling

Queued work is accepted work, not proof of completed workflow execution.

Topic	Status	Guidance
Immediate response	No 202 response declared	OpenAPI does not declare HTTP 202 for this operation.
Polling and terminal states	Not indicated by OpenAPI	No generic polling contract is published from this page.
Later side effects	Not proven	Do not infer background execution beyond the documented response.

Files and artifacts

File-like routes need content-class, ownership, scanning, retention, and URL policy evidence before public recipes.

Topic	Status	Guidance
Content class	No file/artifact class inferred	OpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keys	Not applicable unless a file field is present	Tenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retention	Unresolved unless endpoint-specific evidence exists	Short-lived URLs, MIME limits, checksums, scanner status, retention, expiration, and legal hold behavior are not implied by OpenAPI examples.

Publication warnings

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.
Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes Idempotency

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Needs publication review from documentation classification overlay.	E6 route registry evidence is still required before external publication.
Example validation	Generated examples are internal baseline aids.	No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewed	Implementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.	Refresh this evidence for release workspaces.
Release evidence	E9 required.	No SDK readiness, production readiness, or expanded external docs claim from this endpoint page.

Support public API.

Support public API endpoints create and read local QuickRCM support tickets for the organization selected by the bearer API key. The current public surface has three operations: create a ticket, list tickets visible to the public API actor, and retrieve one visible ticket by `ticketId`. In these docs, `public API actor` should be defined precisely and framed as current implementation behavior, not a permanent identifier contract. user` from an active organization member, and the Support operations verify that member and filter ticket reads by both `organizationId` and that synthetic `userId`. Current actor resolution prefers the earliest active owner member for the organization, falling back to the earliest active member when no owner exists. The actor is not an all-organization support queue and is not a separate ticket namespace for each API key. Public callers should not send `organizationId`, `userId`, status, resolution, assignment, comment, attachment, screenshot, or admin queue fields. The API key selects the organization and the implementation supplies the actor. Ticket `subject`, `description`, `pageUrl`, and `userAgent` are persisted and may be included in support notification email, so examples and guidance must avoid PHI, credentials, tokens, raw EDI, transcripts, S3 keys, payer portal credentials, raw EHR/FHIR responses, and vendor payloads. `pageUrl` is optional string context with a 2000-character cap and nullable storage. The contract does not validate URL syntax, so documentation should describe it as caller-supplied page context and recommend stripping patient-identifying query strings, signed URLs, access tokens, and external portal session details before submission. These endpoints manage local SupportTicket records only. They do not expose comment threads, attachments, ticket updates, lifecycle transitions, SLA controls, admin queues, auto-ticketing from upstream modules, EHR reads/writes, payer actions, or guaranteed email delivery.

What this endpoint does

Use case

Use this endpoint when an external portal, integration, or operations tool needs to file a sanitized QuickRCM support issue, question, billing concern, account issue, performance issue, integration issue, feature request, or other support item.

Before calling

Authenticate with a tenant-scoped bearer API key that has `support:write`; wildcard scopes `support:*`, `public-api:*`, or `*` are also accepted by the shared auth helper. Prepare a valid category, concise sanitized subject, and sanitized details.

Request and response behavior

Request guidance

Send `category`, `subject`, and `description`. Optionally send `priority`, `pageUrl`, and `userAgent`. Do not send `organizationId`, `userId`, `status`, `resolvedAt`, `resolutionNotes`, comments, attachments, screenshots, assignment fields, raw payloads, credentials, tokens, or PHI.

`category` is required and must be one of the documented `STC_*` enum values.
`subject` is trimmed, required, and limited to 200 characters.
`description` is trimmed, required, and limited to 10000 characters.
`priority` is optional and defaults to `STP_MEDIUM` when omitted by current operation behavior.
`pageUrl` is optional, nullable, trimmed, limited to 2000 characters, and stored as caller-supplied context; the contract does not validate URL syntax.
`userAgent` is optional, nullable, trimmed, and limited to 500 characters.
Use opaque QuickRCM or caller-side correlation IDs in free text instead of patient identifiers, raw payer responses, EDI snippets, transcripts, storage keys, or vendor payloads.

Response semantics

A 201 response returns the newly persisted local ticket snapshot. If `priority` is omitted, current operation behavior stores `STP_MEDIUM`; new tickets are stored as `ST_OPEN`. The response is not proof of notification email delivery, support acceptance, SLA start, or external help desk delivery.

`data.id` is the opaque local ticket identifier to store for later get/list correlation.
`data.organizationId` is assigned from authentication context and is returned for correlation only.
`data.subject` and `data.description` echo persisted caller-entered text; do not write those values to logs, analytics, traces, or downstream ticketing systems unless redacted.
`data.status` is `ST_OPEN` for newly created tickets by current operation behavior.
`data.resolvedAt` and `data.resolutionNotes` are normally null for newly created tickets.
Support notification email is attempted after persistence in the underlying operation, but email failure is caught as non-fatal.

Errors and retries

Fix 400 validation failures before retrying. If a network timeout occurs after submission, call listSupportTickets before creating another ticket because this create operation does not expose an idempotency key and retrying can file a duplicate. Back off on 429.

400 means the request body failed required field, enum, min length, or max length validation.
401 means the bearer API key is absent, malformed, invalid, inactive, expired, or otherwise not accepted.
403 can mean the API key lacks an accepted Support write scope or the synthetic actor is not an active member of the selected organization.
429 means the shared public API rate limit was exceeded for the API key.
500 can occur if actor resolution fails because the organization has no active members or if another server error occurs.

Template boundary before examples

The route class, authentication state, tenancy rule, side-effect mode, idempotency status, async behavior, file policy, warnings, links, and evidence above are part of the endpoint contract. Treat generated examples below as internal baseline aids until release evidence closes.

Path parameters

This endpoint does not define path parameters.

Query parameters

This endpoint does not define query parameters.

OpenAPI-declared header parameters

Standard platform header guidance appears in the governance panel. This table only lists operation-specific headers declared in OpenAPI.

This endpoint does not define operation-specific header parameters.

Request body

JSON fields from the generated OpenAPI schema with pilot enrichment applied where available. Nested object fields are shown with dotted paths.

Name	Location	Required	Type	Description	Validation and safety notes
category	body	Yes	STC_BUG \| STC_FEATURE_REQUEST \| STC_QUESTION \| STC_BILLING \| STC_INTEGRATION \| STC_PERFORMANCE \| STC_ACCOUNT \| STC_OTHER	Required Support ticket category enum: `STC_BUG`, `STC_FEATURE_REQUEST`, `STC_QUESTION`, `STC_BILLING`, `STC_INTEGRATION`, `STC_PERFORMANCE`, `STC_ACCOUNT`, or `STC_OTHER`.	Enum values are declared in the Type column.
priority	body	No	STP_LOW \| STP_MEDIUM \| STP_HIGH \| STP_CRITICAL	Optional Support priority enum: `STP_LOW`, `STP_MEDIUM`, `STP_HIGH`, or `STP_CRITICAL`. Current operation behavior defaults an omitted value to `STP_MEDIUM`.	Enum values are declared in the Type column. File, artifact, or raw-payload adjacent; keep examples metadata-only.
subject	body	Yes	string	Required short ticket title, trimmed to 1-200 characters. Keep it concise and sanitized; avoid PHI, secrets, raw EDI, transcripts, and raw external payloads.	Minimum length: 1. Maximum length: 200. Sensitive credential or storage-adjacent value; use placeholders only.
description	body	Yes	string	Required ticket details, trimmed to 1-10000 characters. Include reproduction steps and opaque correlation IDs; avoid patient identifiers, credentials, tokens, raw payer data, raw EHR/FHIR responses, transcripts, S3 keys, and raw EDI.	Minimum length: 1. Maximum length: 10000. Sensitive credential or storage-adjacent value; use placeholders only.
pageUrl	body	No	string	Optional nullable page context string for where the issue occurred, capped at 2000 characters. The public contract does not validate URL syntax; remove patient-identifying query strings, signed URLs, access tokens, and external portal session URLs.	Maximum length: 2000. Sensitive credential or storage-adjacent value; use placeholders only.
userAgent	body	No	string	Optional nullable browser or integration-client context, capped at 500 characters.	Maximum length: 500.

Generated request example

Generated examples are baseline contract aids only. They are not external publication evidence and must not include real PHI, credentials, raw vendor payloads, raw EDI, transcripts, storage keys, or signed URLs.

{
  "category": "STC_BUG",
  "subject": "example-subject",
  "description": "Example support_ticket note",
  "priority": "STP_LOW",
  "pageUrl": "https://example.quickintell.com/resource",
  "userAgent": "example-useragent"
}

Successful responses

Generated response examples show the baseline OpenAPI contract. Tenant identifier echo, PHI redaction, pagination, money, date/time, and enum semantics remain endpoint-specific publication checks.

201

Support ticket created

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000001",
    "organizationId": "00000000-0000-4000-8000-000000000001",
    "category": "STC_BUG",
    "priority": "STP_LOW",
    "status": "ST_OPEN",
    "subject": "example-subject",
    "description": "Example support_ticket note",
    "pageUrl": "https://example.quickintell.com/resource",
    "userAgent": "example-useragent",
    "resolvedAt": "2026-06-08T10:15:30Z",
    "resolutionNotes": "Example support_ticket note",
    "createdAt": "2026-06-08T10:15:30Z",
    "updatedAt": "2026-06-08T10:15:30Z"
  }
}

Error responses

Errors must remain sanitized. Do not include raw payer, EHR, SFTP, SMTP, Stripe, LLM/OCR, browser automation, file, transcript, EDI, worker, or vendor payloads.

400

Invalid request