post
Rate a conversation
Allows a visitor to rate a conversation. The conversation can only be rated once.
Conversations
| Endpoint | /conversations/{token}/rate |
| Method | post |
| Plan Required | FREE |
| Authorization | Bearer Token required |
| Permissions | None |
| Content-Type | application/json |
/conversations/{token}/rateapplication/jsonAPI Tester(Loading...)
Loading API token configuration...
Payload
URL Parameters
tokenstringrequiredConversation token
Body Parameters
Content-Type:
application/jsonrequiredSchema:
| Field | Type | Description / Example |
|---|---|---|
| rating | number | 5 |
| feedback | string | Excellent support, very helpful! |
rating
5feedback
Excellent support, very helpful!Response
200Updated conversation with rating
| Field | Type | Description / Example |
|---|---|---|
| id | number | No example |
| websiteId | number | No example |
| token | string | No example |
| rating | number | No example |
| assigneeId | number | No example |
| visitorId | number | No example |
| visitorTyping | boolean | No example |
| userTyping | boolean | No example |
| createdAt | string | No example |
| status | string | No example |
| firstMessageAt | string | Date and time when the first message was sent by an agent |
| closedAt | string | Date and time when the conversation was closed |
| summary | string | Customer needs help with billing issue and refund ... |
| tags | array | Billing Issue,Refund Request |
id
No example
websiteId
No example
token
No example
rating
No example
assigneeId
No example
visitorId
No example
visitorTyping
No example
userTyping
No example
createdAt
No example
status
No example
firstMessageAt
Date and time when the first message was sent by an agent
closedAt
Date and time when the conversation was closed
summary
Customer needs help with billing issue and refund ...tags
Billing Issue,Refund Request201201 response
| Field | Type | Description / Example |
|---|
400Missing or invalid x-visitor-id header
No response details available
404Conversation not found
No response details available
409Conversation has already been rated
No response details available
Expected Response
JSON
{
"id": "abc123def456",
"websiteId": "abc123def456",
"token": "sk-abc123def456ghi789",
"rating": 42,
"assigneeId": "abc123def456",
"visitorId": "abc123def456",
"visitorTyping": true,
"userTyping": true,
"createdAt": "2024-03-15T14:30:00Z",
"status": "active",
"firstMessageAt": "Hello, this is a test message",
"closedAt": "sample_closedAt",
"summary": "Customer needs help with billing issue and refund processing",
"tags": [
"Billing Issue",
"Refund Request"
]
}API Access Token
Base URL
https://api.5chat.io