Chore: API Improvements (#2956)
- API to fetch info of a single inbox - Document passing custom_attributes in the API - Ability to filter contacts with contact identifier in search API
This commit is contained in:
@@ -5,6 +5,7 @@ post:
|
||||
summary: Create an inbox
|
||||
description: You can create more than one website inbox in each account
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
|
||||
@@ -5,6 +5,7 @@ get:
|
||||
summary: Show Inbox Agent Bot
|
||||
description: See if an agent bot is associated to the Inbox
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- name: id
|
||||
in: path
|
||||
type: number
|
||||
|
||||
@@ -4,6 +4,8 @@ get:
|
||||
operationId: listAllInboxes
|
||||
summary: List all inboxes
|
||||
description: List all inboxes available in the current account
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
|
||||
@@ -5,6 +5,7 @@ post:
|
||||
summary: Add or remove agent bot
|
||||
description: To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- name: id
|
||||
in: path
|
||||
type: number
|
||||
|
||||
22
swagger/paths/inboxes/show.yml
Normal file
22
swagger/paths/inboxes/show.yml
Normal file
@@ -0,0 +1,22 @@
|
||||
get:
|
||||
tags:
|
||||
- Inbox
|
||||
operationId: GetInboxe
|
||||
summary: Get an inbox
|
||||
description: Get an inbox available in the current account
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- name: id
|
||||
in: path
|
||||
type: number
|
||||
description: ID of the inbox
|
||||
required: true
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/inbox'
|
||||
404:
|
||||
description: Inbox not found
|
||||
403:
|
||||
description: Access denied
|
||||
@@ -5,6 +5,7 @@ patch:
|
||||
summary: Update Inbox
|
||||
description: Add avatar and disable auto assignment for an inbox
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- name: id
|
||||
in: path
|
||||
type: number
|
||||
|
||||
Reference in New Issue
Block a user