Conversations
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET |
List all conversations tickets
List tickets with person data attached.
Required API key scopes
ticket:readPath parameters
- project_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /conversations /ticketsExample response
Status 200
RESPONSE
Create conversations tickets
Required API key scopes
ticket:writePath parameters
- project_idstring
Request parameters
- status
- priority
- anonymous_traits
- ai_resolvedboolean
- escalation_reasonstring
Response
Example request
POST /api /projects /:project_id /conversations /ticketsExample response
Status 201
RESPONSE
Retrieve conversations tickets
Get single ticket and mark as read by team.
Required API key scopes
ticket:readPath parameters
- idstring
- project_idstring
Response
Example request
GET /api /projects /:project_id /conversations /tickets /:idExample response
Status 200
RESPONSE
Update conversations tickets
Required API key scopes
ticket:writePath parameters
- idstring
- project_idstring
Request parameters
- status
- priority
- anonymous_traits
- ai_resolvedboolean
- escalation_reasonstring
Response
Example request
PATCH /api /projects /:project_id /conversations /tickets /:idExample response
Status 200
RESPONSE
Delete conversations tickets
Required API key scopes
ticket:writePath parameters
- idstring
- project_idstring
Example request
DELETE /api /projects /:project_id /conversations /tickets /:idExample response
Status 204 No response body
Retrieve conversations tickets unread count
Get total unread ticket count for the team.
Returns the sum of unread_team_count for all non-resolved tickets. Cached in Redis for 30 seconds, invalidated on changes.
Path parameters
- project_idstring
Response
Example request
GET /api /projects /:project_id /conversations /tickets /unread_countExample response
Status 200
RESPONSE