Deskhero Developer Hub
Back to deskhero.com
Tickets

Unlock

Releases the calling User's lock on the ticket. A ticket that is not locked answers as released too, while a lock held by another User answers 423 Locked and stays in place.

DELETE /api/{tenant:minlength(2)}/v{version:apiVersion}/tickets/{id}/lock
Authorisation
Minimum role: USER

Request arguments

Name Type Source
idInt32
Request body example

Response

Status
200 (OK)
Type
DTO_ticket_lock
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 401 (Unauthorized), 403 (Forbidden), 404 (NotFound), 423 (Locked), 429 (TooManyRequests)
Response body example
DTO_ticket_lock
NameTypeReadOnlyDescription
ticket_idInt32The ticket the lock belongs to
is_lockedBooleanTrue while a User holds the ticket. False means the ticket is free and the remaining properties are empty
user_idInt32The User holding the lock, default when the ticket is free
user_nameStringDisplay name of the User holding the lock, for the "locked by" indicator
locked_atDateTime (nullable)When the lock was first taken (UTC). Refreshing the lock keeps this
expires_in_secondsInt32Seconds until the lock expires on its own unless the holder edits the ticket or refreshes it again. 0 when the ticket is free

Generated Aug 22, 2026 09:36