Skip to content
This repository was archived by the owner on Mar 17, 2023. It is now read-only.

Update livechat REST docs #1425

Merged
MartinSchoeler merged 6 commits into from
Dec 23, 2019
Merged

Update livechat REST docs #1425

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a08b0d9
Update livechat departments docs
Oct 1, 2019
906dd54
Add pagination support to livechat users endpoint
Oct 2, 2019
2d8437e
Add includeAgents parameter
Oct 3, 2019
da88346
Merge branch 'master' into livechat-departments
Oct 7, 2019
8b736f1
Merge branch 'master' into livechat-departments
Dec 23, 2019
15bde25
Merge branch 'master' into livechat-departments
MartinSchoeler Dec 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions developer-guides/rest-api/livechat/department/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# List departments

Get a list of departments.
It supports the [Offset, Count, and Sort Query Parameters](../../offset-and-count-and-sort-info/).

| URL | Requires Auth | HTTP Method |
| :---------------------------- | :------------ | :---------- |
Expand Down Expand Up @@ -35,9 +36,10 @@ curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \

## Change Log

| Version | Description |
| :------ | :---------- |
| 0.42.0 | Added |
| Version | Description |
| :------ | :-------------------------- |
| 2.2.0 | Added support to pagination |
| 0.42.0 | Added |

## Register a new department

Expand All @@ -52,6 +54,8 @@ curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
"department": {
"enabled": false,
"showOnRegistration": true,
"email": "email@email.com",
"showOnRegistration": true,
"name": "new from api",
"description": "created from api"
},
Expand Down Expand Up @@ -121,6 +125,14 @@ curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
| :------- | :------------------ | :------- | :-------------------- |
| `_id` | `SQafHvoFPuB57NmBD` | Required | The department `_id`. |

## Query Parameter

| Argument | Example | Required | Description |
| :----------------- | :------------------ | :----------------------- | :---------------------------- |
| `includeAgents` | `true` | Optional(default **true**) | If agents should be included. |

**Note:** The `agents` field will only be returned if the user has the `view-livechat-departments` permission.

## Example Call

```bash
Expand Down Expand Up @@ -161,6 +173,7 @@ curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \

| Version | Description |
| :------ | :---------- |
| 2.2.0 | Added `includeAgents` query parameter |
| 0.42.0 | Added |

## Update a department
Expand Down
3 changes: 2 additions & 1 deletion developer-guides/rest-api/livechat/users/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# List agents or managers

Get a list of agents or managers.
Get a list of agents or managers. It supports the [Offset, Count, and Sort Query Parameters](../../offset-and-count-and-sort-info/).

| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- |
Expand Down Expand Up @@ -42,6 +42,7 @@ curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \

| Version | Description |
| :--- | :--- |
| 2.2.0 | Added support to pagination |
| 0.42.0 | Added |

## Register new agent or manager
Expand Down