v1

latestOpenAPI 3.1.02026-07-121951118.2 KB

Tickets

Update Ticket

Update an existing ticket record by its identifier.

patch/unified/ticketing/tickets/{id}

Path parameters

idstring required

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

unified_custom_fieldsobject nullable

Custom Unified Fields configured in your StackOne project

titlestring nullable

The title or subject of the ticket

reportersstring[] nullable

Users who reported the ticket

assigneesstring[] nullable

Agents assigned to the ticket

parent_idstring nullable

ID of the parent ticket if this is a sub-ticket

tagsstring[] nullable

The tags of the ticket

project_idstring nullable

Project the ticket belongs to

component_idsstring nullable

Components to associate with the ticket

Example request

{
  "unified_custom_fields": {
    "my_project_custom_field_1": "REF-1236",
    "my_project_custom_field_2": "some other value"
  },
  "title": "System outage in production environment",
  "reporters": [
    "user-001",
    "user-002"
  ],
  "assignees": [
    "user-001",
    "user-002"
  ],
  "content": [
    {
      "plain": "This is some content",
      "html": "<p>This is some content</p>"
    }
  ],
  "parent_id": "ticket-002",
  "priority": {
    "id": "001",
    "value": "medium"
  },
  "tags": [
    "tag-001",
    "tag-002"
  ],
  "project_id": "project-001",
  "status": {
    "id": "001",
    "type": {
      "value": "to-do"
    },
    "name": "Backlog"
  }
}

Response

Record updated successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}