Report an issue (Bug / Error, Account Issue, Billing, Feature request).
Accepts multipart/form-data. Uploaded files are emailed to the reporter as MIME
attachments and described (name, type, size) in the admin Teams message. When object
storage is configured they are also uploaded there so the Teams message can link to
them; they are never persisted to the database or local disk.
- category (str): Required. One of
bug,account,billing,feature_request. - description (str): Required. 1–1000 characters.
- reporter_name (str): Required. Display name of the logged-in user filing the issue.
- reporter_email (str): Required. Email of the logged-in user; the summary email is sent here.
- page_url (str): Optional. URL of the current page/route where the issue occurred.
- device (str): Optional. Reporter's device (environment context).
- operating_system (str): Optional. Reporter's operating system (environment context).
- browser_version (str): Optional. Reporter's browser and version (environment context).
- screen_resolution (str): Optional. Reporter's screen resolution (environment context).
- network_status (str): Optional. Network status at report time (technical context).
- client_timestamp (str): Optional. Client-side timestamp when the issue occurred (technical context).
- attachments (list[UploadFile]): Optional. Screenshots or short screen recordings;
count, size, and MIME type limits are enforced via configuration.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Submits an issue report as multipart/form-data. The category is one of bug, account, billing, or feature_request, and the description is 1 to 1,000 characters. A summary email goes to the reporter, and uploaded files are attached to it.
When to use it
Use it to report a problem or request a feature from inside an application. Add the optional environment fields, such as page_url and browser_version, to help support reproduce the issue.
Required parameters
category(body): one ofbug,account,billing, orfeature_request.description(body): the issue, 1 to 1,000 characters.reporter_name(body): the display name of the user filing the issue.reporter_email(body): the email of the user filing the issue; the summary email is sent here.
Optional body fields: page_url, device, operating_system, browser_version, screen_resolution, network_status, client_timestamp, attachments.
Response
A successful call returns 200 OK with notification_status: sent, partial, or failed.
Related: Get an issue report attachment
Unprocessable Entity
Internal Server Error
Bad Gateway