v1

latestOpenAPI 3.1.02026-07-121951118.2 KB

Tickets

Create Ticket

Create a new ticket record.

post/unified/ticketing/tickets

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

creator_idstring nullable

The creator 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

organization_idstring nullable

Organization associated with the ticket

project_idstring nullable

Project the ticket belongs to

component_idsstring nullable

Components to associate with the ticket

typestring nullable

The type of 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",
  "creator_id": "user-001",
  "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"
  ],
  "organization_id": "organization-001",
  "project_id": "project-001",
  "type": "ticket-type-001"
}

Response

Record created successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}