doc: Swagger for conversation priority API (#7172)
This commit is contained in:
28
swagger/paths/application/conversation/toggle_priority.yml
Normal file
28
swagger/paths/application/conversation/toggle_priority.yml
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
tags:
|
||||||
|
- Conversations
|
||||||
|
operationId: toggle-priority-of-a-conversation
|
||||||
|
summary: Toggle Priority
|
||||||
|
description: Toggles the priority of conversation
|
||||||
|
security:
|
||||||
|
- userApiKey: []
|
||||||
|
- agentBotApiKey: []
|
||||||
|
parameters:
|
||||||
|
- name: data
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
required:
|
||||||
|
- priority
|
||||||
|
properties:
|
||||||
|
priority:
|
||||||
|
type: string
|
||||||
|
enum: ["urgent", "high", "medium", "low", "none"]
|
||||||
|
description: "The priority of the conversation"
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: Success
|
||||||
|
404:
|
||||||
|
description: Conversation not found
|
||||||
|
401:
|
||||||
|
description: Unauthorized
|
||||||
@@ -267,6 +267,12 @@
|
|||||||
- $ref: '#/parameters/conversation_id'
|
- $ref: '#/parameters/conversation_id'
|
||||||
post:
|
post:
|
||||||
$ref: ./application/conversation/toggle_status.yml
|
$ref: ./application/conversation/toggle_status.yml
|
||||||
|
/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priority:
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/parameters/account_id'
|
||||||
|
- $ref: '#/parameters/conversation_id'
|
||||||
|
post:
|
||||||
|
$ref: ./application/conversation/toggle_priority.yml
|
||||||
|
|
||||||
# Conversations Assignments
|
# Conversations Assignments
|
||||||
|
|
||||||
|
|||||||
@@ -2877,6 +2877,73 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priority": {
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"$ref": "#/parameters/account_id"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/parameters/conversation_id"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"post": {
|
||||||
|
"tags": [
|
||||||
|
"Conversations"
|
||||||
|
],
|
||||||
|
"operationId": "toggle-priority-of-a-conversation",
|
||||||
|
"summary": "Toggle Priority",
|
||||||
|
"description": "Toggles the priority of conversation",
|
||||||
|
"security": [
|
||||||
|
{
|
||||||
|
"userApiKey": [
|
||||||
|
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"agentBotApiKey": [
|
||||||
|
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "data",
|
||||||
|
"in": "body",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"priority"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"priority": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"urgent",
|
||||||
|
"high",
|
||||||
|
"medium",
|
||||||
|
"low",
|
||||||
|
"none"
|
||||||
|
],
|
||||||
|
"description": "The priority of the conversation"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "Success"
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"description": "Conversation not found"
|
||||||
|
},
|
||||||
|
"401": {
|
||||||
|
"description": "Unauthorized"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments": {
|
"/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments": {
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user