Create a new ticket

Creates a new support ticket in the system

Create a new ticket

post

Creates a new support ticket in the system

Body

application/json

titlestring · min: 1 · max: 255Required

descriptionstring · nullableOptional

ticket_typestring · enumRequiredPossible values:

prioritystring · enumRequiredPossible values:

sourcestring · enumOptionalDefault: harmonyPossible values:

reporterstringRequired

assigneestring · nullableOptional

desk_idstring · min: 1 · max: 60Required

attachment_idsstring[]Optional

created_atstring · date-time · nullableOptional

Optional creation timestamp. If not provided, current time will be used. Used for preserving original ITSM timestamps during import.

related_asset_idsstring · uuid[] · nullableOptional

List of asset IDs (UUIDs) to associate with this ticket

publish_eventsbooleanOptional

Whether to publish domain events for this ticket creation. Set to False to suppress event publishing (useful for bulk imports or migrations). Defaults to True.

Default: true

thread_idstring · uuid · nullableOptional

Optional thread ID to associate with this ticket. If not provided a new thread will be created.

Responses

201

Successful Response

application/json

idstringRequired

titlestringRequired

descriptionstring · nullableOptional

ticket_typestring · enumRequiredPossible values:

prioritystring · enumRequiredPossible values:

sourcestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

reporterstringRequired

created_bystringRequired

assigneestring · nullableOptional

desk_idstringRequired

subdesk_idstringRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

related_asset_idsstring · uuid[] · nullableOptional

List of asset IDs (UUIDs) associated with this ticket

thread_idstring · uuid · nullableOptional

Thread ID for the ticket conversation

response_sla_deadlinestring · date-time · nullableOptional

response_sla_completed_atstring · date-time · nullableOptional

resolution_sla_deadlinestring · date-time · nullableOptional

resolution_sla_completed_atstring · date-time · nullableOptional

422

Validation Error

application/json

post/api/v1/tickets/

HTTPcURLJavaScriptPython

POST /service-desk/api/v1/tickets/ HTTP/1.1
Host: api.harmony.io
Content-Type: application/json
Accept: */*
Content-Length: 462

{
  "title": "text",
  "description": "text",
  "ticket_type": "request",
  "priority": "low",
  "source": "harmony",
  "reporter": "text",
  "assignee": "text",
  "desk_id": "text",
  "attachment_ids": [
    "text"
  ],
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ticket_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_at": "2026-08-11T05:54:38.066Z",
  "related_asset_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "publish_events": true,
  "thread_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "text",
  "title": "text",
  "description": "text",
  "ticket_type": "request",
  "priority": "low",
  "source": "slack",
  "status": "open",
  "reporter": "text",
  "created_by": "text",
  "assignee": "text",
  "desk_id": "text",
  "subdesk_id": "text",
  "created_at": "2026-08-11T05:54:38.066Z",
  "updated_at": "2026-08-11T05:54:38.066Z",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ticket_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "kb_resolution": {
    "answer_summary": "text",
    "sources": [
      {
        "url": "text",
        "title": "text"
      }
    ],
    "chunks_count": 1,
    "confidence": 1,
    "queried_at": "2026-08-11T05:54:38.066Z"
  },
  "workflows": [
    {
      "workflow_id": "text",
      "name": "text",
      "description": "text",
      "workflow_target": "text"
    }
  ],
  "tags": [
    {
      "id": 1,
      "desk_id": "text",
      "name": "text",
      "color": "text",
      "description": "text",
      "system_tag": true,
      "created_at": "2026-08-11T05:54:38.066Z",
      "updated_at": "2026-08-11T05:54:38.066Z"
    }
  ],
  "related_asset_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "thread_id": "123e4567-e89b-12d3-a456-426614174000",
  "response_sla_deadline": "2026-08-11T05:54:38.066Z",
  "response_sla_completed_at": "2026-08-11T05:54:38.066Z",
  "resolution_sla_deadline": "2026-08-11T05:54:38.066Z",
  "resolution_sla_completed_at": "2026-08-11T05:54:38.066Z",
  "watchers": [
    {
      "id": 1,
      "watcher_id": "text",
      "notification_reply_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-08-11T05:54:38.066Z",
      "updated_at": "2026-08-11T05:54:38.066Z"
    }
  ],
  "attachments": [
    {
      "id": "text",
      "filename": "text",
      "content_type": "text",
      "file_size": 1,
      "upload_status": "pending",
      "created_at": "2026-08-11T05:54:38.066Z",
      "updated_at": "2026-08-11T05:54:38.066Z"
    }
  ]
}