Skip to main content
PATCH
/
v1
/
tickets
/
{id}
curl --request PATCH \
--url https://platform.thena.ai/v1/tickets/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"title": "Updated ticket title",
"description": "Updated description for the ticket"
}'
{
"status": true,
"message": "Success",
"timestamp": "2024-01-01T00:00:00.000Z",
"data": {
"id": "<string>",
"ticketIdentifier": "<string>",
"title": "<string>",
"ticketId": 123,
"description": "<string>",
"source": "<string>",
"accountId": "<string>",
"status": "<string>",
"statusId": "<string>",
"priority": "<string>",
"priorityId": "<string>",
"storyPoints": 123,
"account": "<string>",
"teamId": "<string>",
"teamName": "<string>",
"teamIdentifier": "<string>",
"subTeamId": "<string>",
"subTeamName": "<string>",
"subTeamIdentifier": "<string>",
"isPrivate": true,
"typeId": "<string>",
"type": "<string>",
"assignedAgent": "<string>",
"assignedAgentId": "<string>",
"assignedAgentEmail": "<string>",
"assignedAgentAvatar": "<string>",
"requestorEmail": "<string>",
"customerContactId": "<string>",
"customerContactFirstName": "<string>",
"customerContactLastName": "<string>",
"customerContactEmail": "<string>",
"submitterEmail": "<string>",
"customFieldValues": [
"<string>"
],
"deletedAt": "<string>",
"archivedAt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"formId": "<string>",
"aiGeneratedTitle": "<string>",
"aiGeneratedSummary": "<string>",
"sentiment": "<string>",
"sentimentId": "<string>",
"teamIcon": "<string>",
"teamColor": "<string>",
"teamOrganizationId": "<string>",
"teamParentTeamId": "<string>",
"teamDescription": "<string>",
"teamConfigurationId": "<string>",
"teamTeamOwnerId": "<string>",
"teamIsActive": true,
"teamIsPrivate": true,
"teamCreatedAt": "<string>",
"teamUpdatedAt": "<string>",
"teamDeletedAt": "<string>",
"teamArchivedAt": "<string>",
"subTeamIcon": "<string>",
"subTeamColor": "<string>",
"subTeamOrganizationId": "<string>",
"subTeamParentTeamId": "<string>",
"subTeamDescription": "<string>",
"subTeamConfigurationId": "<string>",
"subTeamTeamOwnerId": "<string>",
"subTeamIsActive": true,
"subTeamIsPrivate": true,
"subTeamCreatedAt": "<string>",
"subTeamUpdatedAt": "<string>",
"subTeamDeletedAt": "<string>",
"subTeamArchivedAt": "<string>",
"lastCustomerComment": "<string>",
"lastVendorComment": "<string>",
"closedAt": "<string>",
"closedBy": "<string>",
"closedById": "<string>",
"closedByEmail": "<string>",
"lastComment": "<string>"
}
}

Authorizations

x-api-key
string
header
required

Enter your API key

Path Parameters

id
string
required

Body

application/json

Update ticket request body

assignedAgentId
string

The ID of the assigned agent

accountId
string

The ID of the account

assignedAgentEmail
string

The email of the assigned agent

description
string

The description of the ticket

dueDate
string<date-time>

The due date of the ticket

submitterEmail
string

The email of the submitter

statusId
string

The ID of the status, status id if provided is used over status name

statusName
string

The name of the status to match against

priorityId
string

The ID of the priority, priority id if provided is used over priority name

priorityName
string

The name of the priority to match against

sentimentId
string

The ID of the sentiment

metadata
object

The metadata of the ticket

typeId
string

The ID of the type

isPrivate
boolean

Whether the ticket is private

source
string

The source of the ticket

aiGeneratedTitle
string

The AI generated title of the ticket

aiGeneratedSummary
string

The AI generated summary of the ticket

attachmentUrls
string[]

The attachment URLs

customFieldValues
object[]

The custom field values

isProactive
boolean
default:false

Whether the ticket is proactive

closedAt
string<date-time>

The closed date of the ticket

closedById
string

The ID of the user who closed the ticket

proactiveChannels
enum<string>[]

The proactive channels associated with the ticket

title
string

The title of the ticket

subTeamId
string

The ID of the sub-team

formId
string

The ID of the form

Whether to auto-link Slack channel metadata from the ticket to the selected account

Response

Operation successful

status
boolean
default:true
required

The status of the response

message
string
default:Success
required

The message of the response

timestamp
string<date-time>
default:2024-01-01T00:00:00.000Z
required

The timestamp of the response

data
object
required

The response for create/update/delete ticket operations