Bearer authentication header of the form Bearer <token>.
Path parameters
ticketIdstringrequired
Headers
projectstringrequired
Bodyapplication/jsonrequired
titlestring
conversationClosedboolean
botobject
Show child attributes
activeboolean
currentBotstring
currentActionFlowstring
currentActionnumber<double>
forwardedToSupportAtstring<date-time>
kaiActiveboolean
noAnswerFoundboolean
contentany
plainContentstring
imageUrlstring
Show 82 more attributes
descriptionstring
latestCommentstring
latestPublicCommentstring
slaBreachedboolean
hiddenboolean
needInitialPushboolean
noHumanInteractionboolean
snoozedboolean
snoozedUntilstring<date-time> | null
processingUserstring
processingTeamstring
queuedboolean
queuedAtstring<date-time>
mentionsstring[]
emailRefsany[]
attributesany
formDataany
formany
aiSummarystring
aiSupportSummarystring
dueDatestring<date-time> | string
Any of
string<date-time>
string
linkedTicketsstring[]
duplicateOfstring
duplicatesCountnumber<double>
sessionany
sessionsany[]
outboundstring
prioritystring
Priority key of the ticket's board: LOW, MEDIUM, HIGH or a custom key; the
priority's title is also accepted. Each board's priorities are listed by
GET /projects/ticket-types.
typestring
sentimentenum<string>
Allowed values: positivenegativeneutral
statusstring
shareTokenstring
secretShareTokenstring
lexorankstring
bugIdnumber<double>
projectstring
organisationstring
screenshotUrlstring
screenshotBrokestring<date-time>
generatingScreenshotboolean
screenshotRenderingFailedboolean
screenshotLiveboolean
screenshotDataUrlany
isSilentboolean
replayDataUrlstring
replayUrlstring
generatingReplayboolean
replayStartDatestring<date-time>
replayRenderingStartedAtstring<date-time>
replayRenderingFailedboolean
replayLiveboolean
originalEmailContentstring
hasWebReplayboolean
integrationsany
metaDataany
actionLogany
customDataany
replayany
lastResponseobject
Show child attributes
contactstring<date-time>
adminstring<date-time>
attachmentsobject[]
Show child attributes
namestringrequired
urlstringrequired
typestring
lastNotificationstring<date-time>
faqSuggestedboolean
notificationsUnreadboolean
sessionNotificationsUnreadboolean
hasAgentReplyboolean
conversationRatingnumber<double>
upvotesCountnumber<double>
upvotesobject[]
Show child attributes
emailstring
screenRecordingUrlstring
firstAssignmentAtstring<date-time>
archivedboolean
archivedAtstring<date-time>
disabledboolean
isSpamboolean
tagsstring[]
scorenumber<double>
channelobject
Show child attributes
idstringrequired
typestring
metaDataany
manuallyAddedboolean
fromDataany
forceCloseOverrideboolean
pipelineEntrystring[]
CRM pipeline entries to link this ticket to, verified against the project in
updateTicket (unknown/foreign ids drop the change). The list REPLACES the
ticket's links — send [] to unlink it from every entry.
companyIdstring
The company this conversation is with, by its companyId. Changes the ticket only: no contact
moves. Must be a company of the project (anything else is ignored); "" clears it.
