Update a ticket

Update an existing ticket

Update a ticket

patch

Updates an existing ticket with the provided fields

Path parameters

ticket_idstringRequired

Body

application/json

titlestring · min: 1 · max: 255 · nullableOptional

descriptionstring · nullableOptional

ticket_typestring · enum · nullableOptionalPossible values:

prioritystring · enum · nullableOptionalPossible values:

statusstring · enum · nullableOptionalPossible values:

assigneestring · nullableOptional

assignee, to unassign pass in _UNASSIGN_

desk_idstring · min: 1 · max: 60 · nullableOptional

subdesk_idstring · min: 1 · max: 60 · nullableOptional

Subdesk ID to move ticket to (must be in same desk)

notification_reply_idstring · nullableOptional

attachment_idsstring[] · nullableOptional

List of attachment IDs to link to this ticket

created_atstring · date-time · nullableOptional

Optional creation timestamp override. Used for backfilling original ITSM timestamps during re-evaluation.

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

publish_eventsbooleanOptional

Whether to publish domain events for this ticket update. Set to False to suppress event publishing (useful for bulk imports or migrations). Defaults to True. This suppresses ALL events including status changes, assignee changes, and survey triggers.

Default: true

Responses

200

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

patch/api/v1/tickets/{ticket_id}

HTTPcURLJavaScriptPython

PATCH /service-desk/api/v1/tickets/{ticket_id} HTTP/1.1
Host: api.harmony.io
Content-Type: application/json
Accept: */*
Content-Length: 596

{
  "title": "text",
  "description": "text",
  "ticket_type": "request",
  "priority": "low",
  "status": "open",
  "assignee": "text",
  "desk_id": "text",
  "subdesk_id": "text",
  "notification_reply_id": "text",
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ticket_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "attachment_ids": [
    "text"
  ],
  "created_at": "2026-08-11T05:54:38.057Z",
  "response_sla_deadline": "2026-08-11T05:54:38.057Z",
  "response_sla_completed_at": "2026-08-11T05:54:38.057Z",
  "resolution_sla_deadline": "2026-08-11T05:54:38.057Z",
  "resolution_sla_completed_at": "2026-08-11T05:54:38.057Z",
  "publish_events": true
}

{
  "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.057Z",
  "updated_at": "2026-08-11T05:54:38.057Z",
  "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.057Z"
  },
  "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.057Z",
      "updated_at": "2026-08-11T05:54:38.057Z"
    }
  ],
  "related_asset_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "thread_id": "123e4567-e89b-12d3-a456-426614174000",
  "response_sla_deadline": "2026-08-11T05:54:38.057Z",
  "response_sla_completed_at": "2026-08-11T05:54:38.057Z",
  "resolution_sla_deadline": "2026-08-11T05:54:38.057Z",
  "resolution_sla_completed_at": "2026-08-11T05:54:38.057Z"
}