Ticket

Update a ticket

Changed on

Update a ticket in a project.

put/tickets/{ticketId}

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/tickets/{ticketId}
  • Auth
    HTTP bearer

Path parameters

ticketIdstring required

Headers

projectstring required

Request body

titlestring
conversationClosedboolean
contentunknown
plainContentstring
imageUrlstring
descriptionstring
latestCommentstring
latestPublicCommentstring
slaBreachedboolean
hiddenboolean
needInitialPushboolean
noHumanInteractionboolean
snoozedboolean
snoozedUntilstring date-time nullable
processingUserstring
processingTeamstring
queuedboolean
queuedAtstring date-time
mentionsstring[]
attributesunknown
formDataunknown
formunknown
aiSummarystring
aiSupportSummarystring
linkedTicketsstring[]
duplicateOfstring
duplicatesCountnumber double
sessionunknown
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
sentiment'positive' | 'negative' | 'neutral'
statusstring
shareTokenstring
secretShareTokenstring
lexorankstring
bugIdnumber double
projectstring
organisationstring
screenshotUrlstring
screenshotBrokestring date-time
generatingScreenshotboolean
screenshotRenderingFailedboolean
screenshotLiveboolean
screenshotDataUrlunknown
isSilentboolean
replayDataUrlstring
replayUrlstring
generatingReplayboolean
replayStartDatestring date-time
replayRenderingStartedAtstring date-time
replayRenderingFailedboolean
replayLiveboolean
originalEmailContentstring
hasWebReplayboolean
integrationsunknown
metaDataunknown
actionLogunknown
customDataunknown
replayunknown
lastNotificationstring date-time
faqSuggestedboolean
notificationsUnreadboolean
sessionNotificationsUnreadboolean
hasAgentReplyboolean
conversationRatingnumber double
upvotesCountnumber double
screenRecordingUrlstring
firstAssignmentAtstring date-time
archivedboolean
archivedAtstring date-time
disabledboolean
isSpamboolean
tagsstring[]
scorenumber double
manuallyAddedboolean
fromDataunknown
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.

Response

Ok

unknown required

Changes

  • f43fe8f51aa9Revision changes
    • breaking

      removed the enum value HIGH of the request property

    • breaking

      removed the enum value LOW of the request property

    • breaking

      removed the enum value MEDIUM of the request property

  • e5c29a5d9528Revision changes
    • breaking

      the request property type changed from string to array