Open a support ticket

Opens a support conversation for the acting PAT/OAuth user and includes the first message. The acting identity becomes the ticket opener and normal message author; integrations cannot open a ticket for another user through this endpoint.

POST/support/tickets

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Request body

requiredapplication/json

messagestringrequired

The first support message as Markdown or HTML.

Accepts Markdown or HTML for complex formatting. This content is rendered by the Leadtime rich editor, not by a plain Markdown viewer.

For quick/simple text, Markdown is acceptable. For polished user-facing content from an agent or integration, prefer structured HTML because it preserves editor blocks, links, and layout more predictably.

Use only the nodes and marks documented below for this field. Supported editor features differ by endpoint and field. Choose formatting for readability, not decoration: use headings for real sections, paragraphs for narrative text, lists or tables for structured facts, blockquotes for quoted context, callouts for important outcomes/risks/notes when supported, and explicit anchors for links. Do not rely on bare URLs or Markdown links when the link must be clickable; use explicit anchors such as <a href="https://example.com" target="_blank" rel="noopener noreferrer nofollow">link text</a>.

In HTML you can use:

Node Types and Marks

Nodes

paragraph Type: block Content: inline* (inline only — do not use block tags such as inside; use e.g. , , , …) Default paragraph. extraPlaceholder is an internal structure for the editor to show a ghost placeholder in empty “template” lines (ProseMirror JSON fragment or null). For normal agent output leave extraPlaceholder as null. Only set it if you are intentionally mirroring a field placeholder the user already has in the open editor; do not set random placeholder data for free-form answers. Atts:

extraPlaceholder: null

<p class="paragraph-base" extraplaceholder="null/some-value"></p>

heading Type: block Content: inline* (inline only — do not use block tags such as inside; use e.g. , , , …) Atts:

level: 1

<h1 class="heading-base"></h1>

bulletList Type: block list Content: listItem+ Atts: none

<ul class="list-base"><li></li></ul>

hardBreak Type: inline Atts: none

<br>

horizontalRule Type: block Atts: none

<hr class="hr-base">

orderedList Type: block list Content: listItem+ Atts:

start: 1
type: null

<ol class="order-list-base" type="null/some-value"><li></li></ol>

listItem Content: (paragraph|list)* (paragraphs and/or lists, in any order) Atts: none

<li></li>

blockquote Type: block Content: block+ (one or more block child nodes (e.g. paragraph, list, …)) Atts: none

<blockquote class="blockquote-base"><p class="paragraph-base"></p></blockquote>

Marks

link Atts:

href: null
target: _blank
rel: noopener noreferrer nofollow
class: null
title: null

<a target="_blank" rel="noopener noreferrer nofollow" href="">link text example</a>

bold Atts: none

<strong>bold text example</strong>

code Atts: none

<code>code text example</code>

italic Atts: none

<em>italic text example</em>

strike Atts: none

<s>strike text example</s>

underline Atts: none

<u>underline text example</u>

Responses

201

Created ticket with the complete conversation.

createdAtstring<date-time>required

When the ticket was opened.

idstringrequired

Support ticket UUID.

lastMessageAtstring<date-time>required

When the newest message was created.

lastMessageAuthorSidestringrequired

Which side wrote the newest message.

Allowed:UserAdmin

lastMessageTextBodystringrequired

Plain-text preview of the newest message.

messagesSupportMessageDto[]required

Complete conversation ordered from oldest to newest.

Show properties

Array of SupportMessageDto

authorSidestringrequired

Whether the opener or the Leadtime team wrote the message.

Allowed:UserAdmin

authorUserIdobject | nullrequired

The ticket opener user UUID for opener-authored messages. Null for Leadtime team messages.

bodystringrequired

Message body rendered as HTML.

createdAtstring<date-time>required

When the message was created.

idstringrequired

Support message UUID.

manageAuthorobject | nullrequired

Name and avatar of the Leadtime team member for team-authored messages. Never contains an email address.

Show properties

avatarobject | nullrequired

Avatar configuration for the Leadtime team member. Null when no avatar is configured.

Show properties

idstringrequired

Stable avatar configuration identifier.

kindstringrequired

How the support team member avatar is rendered.

Allowed:generateduploadedleadtimeAgent

optionsobject

Generated-avatar rendering options.

stylestring

Generated-avatar style when kind is generated.

Allowed:adventurerbotttsinitialspersonasnotionistsdylanbottts-neutral

namestringrequired

Display name of the Leadtime team member.

textBodystringrequired

Plain-text message body for summaries and search.

statusstringrequired

Current ticket status.

Allowed:OpenClosed

titlestringrequired

Generated ticket title, or the immediate first-message fallback while generation is running.

titleIsGeneratingbooleanrequired

Whether a generated title is still being prepared.

unreadbooleanrequired

Whether the acting opener has an unread message from the Leadtime team.

userLastSeenAtobject<date-time> | nullrequired

When the ticket opener last viewed the conversation.

400

The first message is empty or invalid.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

messagestring*The first support message as Markdown or HTML. Accepts Markdown or HTML for complex formatting. This content is rendered by the Leadtime rich editor, not by a plain Markdown viewer. For quick/simple text, Markdown is acceptable. For polished user-facing content from an agent or integration, prefer structured HTML because it preserves editor blocks, links, and layout more predictably. Use only the nodes and marks documented below for this field. Supported editor features differ by endpoint and field. Choose formatting for readability, not decoration: use headings for real sections, paragraphs for narrative text, lists or tables for structured facts, blockquotes for quoted context, callouts for important outcomes/risks/notes when supported, and explicit anchors for links. Do not rely on bare URLs or Markdown links when the link must be clickable; use explicit anchors such as <a href="https://example.com" target="_blank" rel="noopener noreferrer nofollow">link text</a>. In HTML you can use: ## Node Types and Marks ### Nodes **paragraph** Type: block Content: inline* (inline only — do not use block tags such as inside; use e.g. , , , …) Default paragraph. extraPlaceholder is an internal structure for the editor to show a ghost placeholder in empty “template” lines (ProseMirror JSON fragment or null). For normal agent output leave extraPlaceholder as null. Only set it if you are intentionally mirroring a field placeholder the user already has in the open editor; do not set random placeholder data for free-form answers. Atts: - extraPlaceholder: null ```html ``` **heading** Type: block Content: inline* (inline only — do not use block tags such as inside; use e.g. , , , …) Atts: - level: 1 ```html <h1 class="heading-base"></h1> ``` **bulletList** Type: block list Content: listItem+ Atts: none ```html <ul class="list-base"><li></li></ul> ``` **hardBreak** Type: inline Atts: none ```html ``` **horizontalRule** Type: block Atts: none ```html <hr class="hr-base"> ``` **orderedList** Type: block list Content: listItem+ Atts: - start: 1 - type: null ```html <ol class="order-list-base" type="null/some-value"><li></li></ol> ``` **listItem** Content: (paragraph|list)* (paragraphs and/or lists, in any order) Atts: none ```html <li></li> ``` **blockquote** Type: block Content: block+ (one or more block child nodes (e.g. paragraph, list, …)) Atts: none ```html <blockquote class="blockquote-base"></blockquote> ``` ### Marks **link** Atts: - href: null - target: _blank - rel: noopener noreferrer nofollow - class: null - title: null ```html <a target="_blank" rel="noopener noreferrer nofollow" href="">link text example</a> ``` **bold** Atts: none ```html bold text example ``` **code** Atts: none ```html <code>code text example</code> ``` **italic** Atts: none ```html italic text example ``` **strike** Atts: none ```html <s>strike text example</s> ``` **underline** Atts: none ```html underline text example ```

Request

curl -X POST "https://leadtime.app/api/public/support/tickets" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "<p>The project page stays blank after I select the Acme project. I already refreshed the page and signed in again.</p>"
}'

const response = await fetch("https://leadtime.app/api/public/support/tickets", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"message\": \"<p>The project page stays blank after I select the Acme project. I already refreshed the page and signed in again.</p>\"\n}"
});

import requests

response = requests.post(
    "https://leadtime.app/api/public/support/tickets",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"message\": \"<p>The project page stays blank after I select the Acme project. I already refreshed the page and signed in again.</p>\"\n}",
)

Response

{
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "5532b85e-bef7-48c9-9272-9de7c63a1234",
  "lastMessageAt": "2019-08-24T14:15:22Z",
  "lastMessageAuthorSide": "User",
  "lastMessageTextBody": "The project page stays blank after I select it.",
  "messages": [
    {
      "authorSide": "User",
      "authorUserId": "65bc3ac7-d43b-43c9-b3f2-4bd3b46c96bc",
      "body": "<p>The project page stays blank after I select it.</p>",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "81008f98-5921-4acb-936b-62d122d1fcfd",
      "manageAuthor": {
        "avatar": {
          "id": "9c26ca8f-fc9a-40fc-b5e0-ec0aa344f6fd",
          "kind": "generated",
          "options": {},
          "style": "adventurer"
        },
        "name": "Alex Morgan"
      },
      "textBody": "The project page stays blank after I select it."
    }
  ],
  "status": "Open",
  "title": "Project page stays blank",
  "titleIsGenerating": true,
  "unread": true,
  "userLastSeenAt": {}
}