patch
Update a ticket
Updates specific fields of an existing ticket.
Tickets
| Endpoint | /tickets/{id} |
| Method | patch |
| Plan Required | PRO |
| Authorization | Bearer Token required |
| Permissions | WRITE |
| Content-Type | application/json |
/tickets/{id}WRITE
application/jsonAPI Tester(Loading...)
Loading API token configuration...
Payload
URL Parameters
idstringrequiredTicket ID to update
Body Parameters
Content-Type:
application/jsonrequiredSchema:
| Field | Type | Description / Example |
|---|---|---|
| title | string | No example |
| description | string | No example |
| string | No example | |
| priority | string | No example |
| status | string | No example |
| visitorToken | string | No example |
| assigneeId | number | No example |
title
No example
description
No example
No example
priority
No example
status
No example
visitorToken
No example
assigneeId
No example
Response
200Updated ticket
| Field | Type | Description / Example |
|---|---|---|
| id | string | 123456789 |
| websiteId | number | 1 |
| visitorId | number | 1 |
| conversationId | number | 1 |
| title | string | Login issue with mobile app |
| description | string | User cannot login to the mobile app after recent u... |
| status | string | NEW |
| priority | string | MEDIUM |
| assigneeId | number | 1 |
| uniqueEmailAddress | string | [email protected] |
| languageCode | string | en |
| summary | string | Customer experiencing login issues with mobile app... |
| createdAt | string | 2023-12-01T10:00:00Z |
| updatedAt | string | 2023-12-01T15:30:00Z |
| website | object | Website information |
| visitor | object | Visitor information |
| assignee | object | Assigned user information |
| messages | array | Ticket messages |
| tags | array | technical-issue,mobile-app,urgent |
id
123456789websiteId
1visitorId
1conversationId
1title
Login issue with mobile appdescription
User cannot login to the mobile app after recent u...status
NEWpriority
MEDIUMassigneeId
1uniqueEmailAddress
languageCode
ensummary
Customer experiencing login issues with mobile app...createdAt
2023-12-01T10:00:00ZupdatedAt
2023-12-01T15:30:00Zwebsite
Website information
visitor
Visitor information
assignee
Assigned user information
messages
Ticket messages
tags
technical-issue,mobile-app,urgent400Bad request - Invalid data
No response details available
401Unauthorized - Invalid or missing API token
No response details available
404Ticket not found
No response details available
Expected Response
JSON
{
"id": "123456789",
"websiteId": 1,
"visitorId": 1,
"conversationId": 1,
"title": "Login issue with mobile app",
"description": "User cannot login to the mobile app after recent update",
"status": "NEW",
"priority": "MEDIUM",
"assigneeId": 1,
"uniqueEmailAddress": "[email protected]",
"languageCode": "en",
"summary": "Customer experiencing login issues with mobile app after update. Requires technical assistance with account access.",
"createdAt": "2023-12-01T10:00:00Z",
"updatedAt": "2023-12-01T15:30:00Z",
"website": "https://mywebsite.com",
"visitor": {},
"assignee": {},
"messages": "Hello, this is a test message",
"tags": [
"technical-issue",
"mobile-app",
"urgent"
]
}API Access Token
Base URL
https://api.5chat.io