2020-03-11 10:49:13 +00:00
|
|
|
post:
|
|
|
|
|
tags:
|
2020-04-20 06:25:06 +00:00
|
|
|
- Inbox
|
|
|
|
|
operationId: inboxCreation
|
|
|
|
|
summary: Create an inbox
|
2020-03-11 10:49:13 +00:00
|
|
|
description: You can create more than one website inbox in each account
|
|
|
|
|
parameters:
|
|
|
|
|
- name: data
|
|
|
|
|
in: body
|
|
|
|
|
required: true
|
|
|
|
|
schema:
|
|
|
|
|
type: object
|
|
|
|
|
properties:
|
2020-04-20 06:25:06 +00:00
|
|
|
name:
|
|
|
|
|
type: string
|
|
|
|
|
description: The name of the inbox
|
|
|
|
|
avatar:
|
|
|
|
|
type: file
|
|
|
|
|
description: File for avatar image
|
|
|
|
|
channel:
|
2020-03-11 10:49:13 +00:00
|
|
|
type: object
|
|
|
|
|
properties:
|
2020-04-20 06:25:06 +00:00
|
|
|
type:
|
2020-03-11 10:49:13 +00:00
|
|
|
type: string
|
2020-04-20 06:25:06 +00:00
|
|
|
enum: ['web_widget']
|
2020-03-11 10:49:13 +00:00
|
|
|
website_url:
|
|
|
|
|
type: string
|
|
|
|
|
description: URL at which the widget will be loaded
|
2020-04-20 06:25:06 +00:00
|
|
|
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
|
2020-03-11 10:49:13 +00:00
|
|
|
widget_color:
|
|
|
|
|
type: string
|
|
|
|
|
description: A Hex-color string used to customize the widget
|
|
|
|
|
responses:
|
|
|
|
|
200:
|
|
|
|
|
description: Success
|
|
|
|
|
schema:
|
|
|
|
|
$ref: '#/definitions/inbox'
|
|
|
|
|
404:
|
|
|
|
|
description: Inbox not found
|
|
|
|
|
403:
|
|
|
|
|
description: Access denied
|
