Skip to main content
POST
Claim ticket
Requires Premium or Enterprise subscription

Overview

Claim a ticket for handling by a staff member. Sets the ticket status to in-progress. Important Notes:
  • Only one staff member can claim a ticket at a time
  • Claimed tickets cannot be claimed by another staff member until unclaimed
  • A system message is automatically added when claiming

Path Parameters

string
required
Ticket ID

Request Body

integer
required
UserId of the staff member claiming the ticket

Response

boolean
Whether the request was successful
object

Example

Response Example

Error Responses

Rate Limit

25 requests per second per API key

Authorizations

apikey
string
header
required

Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.

Path Parameters

ticketId
string
required

Ticket ID

Body

application/json
staffUserId
integer
required

UserId of the staff member claiming the ticket

Response

Ticket claimed successfully