Skip to main content
POST
/
tickets
/
{ticketId}
/
claim
Claim ticket
curl --request POST \
  --url https://api.series.hr/tickets/{ticketId}/claim \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "staffUserId": 123
}
'
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

​
ticketId
string
required
Ticket ID

​
Request Body

​
staffUserId
integer
required
UserId of the staff member claiming the ticket

​
Response

​
success
boolean
Whether the request was successful
​
data
object

​
Example

curl -X POST "https://api.series.hr/tickets/TICKET-1234567890-ABCD/claim" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "staffUserId": 987654321
  }'

​
Response Example

{
  "success": true,
  "data": {
    "message": "Ticket claimed successfully"
  }
}

​
Error Responses

{
  "success": false,
  "error": {
    "code": 400,
    "message": "Ticket already claimed"
  }
}

{
  "success": false,
  "error": {
    "code": 403,
    "message": "Tickets module requires a Premium or Enterprise subscription"
  }
}

{
  "success": false,
  "error": {
    "code": 404,
    "message": "Ticket not found"
  }
}

​
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