akadmin/chatwoot
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

feat: Finish adding all request payload examples

Browse Source
This commit is contained in:
Daniel Jimenez
2025-05-13 14:29:02 +12:00
parent c3f741bdda
commit 2c3a3bbbd2
31 changed files with 865 additions and 496 deletions
Download Patch File Download Diff File Expand all files Collapse all files
swagger/paths/application/inboxes/create.yml
+1 -30
View File
@@ -13,36 +13,7 @@ post:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the inbox
avatar:
type: string
format: binary
description: File for avatar image
channel:
type: object
properties:
type:
type: string
enum: ['web_widget']
website_url:
type: string
description: URL at which the widget will be loaded
welcome_title:
type: string
description: Welcome title to be displayed on the widget
welcome_tagline:
type: string
description: Welcome tagline to be displayed on the widget
agent_away_message:
type: string
description: A message which will be sent if there is not agent available. This is not available if agentbot is connected
widget_color:
type: string
description: A Hex-color string used to customize the widget
$ref: '#/components/schemas/inbox_create_update_payload'
responses:
'200':
description: Success
swagger/paths/application/inboxes/inbox_members/create.yml
+3 -1
View File
@@ -16,13 +16,15 @@ requestBody:
- user_ids
properties:
inbox_id:
type: string
type: integer
description: The ID of the inbox
example: 1
user_ids:
type: array
items:
type: integer
description: IDs of users to be added to the inbox
example: [1, 2, 3]
responses:
'200':
description: Success
swagger/paths/application/inboxes/inbox_members/update.yml
+2
View File
@@ -18,11 +18,13 @@ requestBody:
inbox_id:
type: string
description: The ID of the inbox
example: 1
user_ids:
type: array
items:
type: integer
description: IDs of users to be added to the inbox
example: [1, 2, 3]
responses:
'200':
description: Success
swagger/paths/application/inboxes/set_agent_bot.yml
+1
View File
@@ -26,6 +26,7 @@ post:
agent_bot:
type: number
description: 'Agent bot ID'
example: 1
responses:
'204':
description: Success
swagger/paths/application/inboxes/update.yml
+1 -32
View File
@@ -19,38 +19,7 @@ patch:
content:
application/json:
schema:
type: object
required:
- enable_auto_assignment
properties:
name:
type: string
description: The name of the inbox
enable_auto_assignment:
type: boolean
description: 'Enable Auto Assignment'
avatar:
type: string
format: binary
description: 'Image file for avatar'
channel:
type: object
properties:
website_url:
type: string
description: URL at which the widget will be loaded
welcome_title:
type: string
description: Welcome title to be displayed on the widget
welcome_tagline:
type: string
description: Welcome tagline to be displayed on the widget
agent_away_message:
type: string
description: A message which will be sent if there is not agent available. This is not available if agentbot is connected
widget_color:
type: string
description: A Hex-color string used to customize the widget
$ref: '#/components/schemas/inbox_create_update_payload'
responses:
'200':
description: Success