Update Ticket

Provides the function to modify ticket information.

Request Method

PUT

Request URL

https://livedesk-api.engagelab.com/api/v2/accounts/tickets/:ticket_id

Authentication

See the authentication description in API Overview for details.

Request

Request Example

curl -X PUT 'https://livedesk-api.engagelab.com/api/v2/accounts/tickets/:ticket_id' \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ -d '{ "title": "Printer paper jam, unable to print (Updated)", "description": "Customer reported A4 paper jammed at the output tray, needs urgent handling.\nTechnician has been dispatched.", "attachments": [ { "file_url": "https://example.com/files/error-photo.jpg" } ], "priority": "normal", "ticket_type": "incident", "custom_fields": { "department": "IT Support", "device_sn": "PRN-2024-001", "location": "Beijing HQ - 3rd Floor Print Room", "resolution_note": "Replaced the paper feed mechanism" }, "tags": ["printer", "hardware", "resolved"] }'

              
              curl -X PUT 'https://livedesk-api.engagelab.com/api/v2/accounts/tickets/:ticket_id' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
-d '{
  "title": "Printer paper jam, unable to print (Updated)",
  "description": "Customer reported A4 paper jammed at the output tray, needs urgent handling.\nTechnician has been dispatched.",
  "attachments": [
    {
      "file_url": "https://example.com/files/error-photo.jpg"
    }
  ],
  "priority": "normal",
  "ticket_type": "incident",
  "custom_fields": {
    "department": "IT Support",
    "device_sn": "PRN-2024-001",
    "location": "Beijing HQ - 3rd Floor Print Room",
    "resolution_note": "Replaced the paper feed mechanism"
  },
  "tags": ["printer", "hardware", "resolved"]
}'

This code block in the floating window

Request Headers

Field	Type	Description
Authorization	string	Use `Authorization: Basic base64(API Key:API Secret)` for authentication. Please go to the API Key page to get the API Key and API Secret, and connect them with a colon before Base64 encoding.
Content-Type	application/json	Data type, value is application/json.

Path Parameters

Field	Type	Required	Description
ticket_id	String	Yes	Ticket ID.

Body Parameters

Field	Type	Required	Description
title	String	Yes	Ticket title.
description	String	Yes	Ticket detailed description (supports Markdown).
attachments	Array	No	Ticket-level attachment list. file_url: File address.
priority	String	No	Priority: low/medium/high/urgent. Default is medium if not passed.
ticket_type	String	No	Ticket type: incident/question/problem/task.
custom_fields	Object	No	Custom fields (e.g., device serial number, order number, etc.).
tags	Array	No	Ticket tags.

Response Example

Success Response

{ "code": 0, "message": "Success", "data": { "ticket_id": "tk_20251104_789abc", "updated_at": "2025-11-04T10:30:00+08:00" } }

              
              {
  "code": 0,
  "message": "Success",
  "data": {
    "ticket_id": "tk_20251104_789abc",
    "updated_at": "2025-11-04T10:30:00+08:00"
  }
}

This code block in the floating window

Response Parameters

Field	Type	Required	Description
ticket_id	String	No	Ticket ID.
updated_at	String	No	Update time.