| Parameter name | Value | Description |
|---|---|---|
id |
string |
Identifier of the group. |
name |
string |
Name of the group. |
color |
string |
Group color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF. |
members |
list |
Service list of the group. |
members[].name |
string |
Name of the service. |
members[].id |
string |
Identifier of the service. |
Authentication is required to execute this request. Please refer to Authentication for more.
{companyId}/serviceGroups/{groupId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
companyId |
string |
Company identifier. |
groupId |
string |
Group identifier. |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Authentication is required to execute this request. Please refer to Authentication for more.
{companyId}/serviceGroups/{groupId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
companyId |
string |
Company identifier. |
groupId |
string |
Group identifier. |
Do not supply a request body with this method.
If successful, this method returns a Group resource in the response body.
Returns entries on the company's staff group list.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
companyId |
string |
Company identifier. |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
companyId |
string |
Company identifier. |
In the request body, supply a Group resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Required Properties | ||
name |
string |
Name of the group. |
| Optional Properties | ||
color |
string |
Group color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF. |
members |
list |
Service list of the group. |
members[].id |
string |
Identifier of the service. |
If successful, this method returns a Staff member resource in the response body.
Authentication is required to execute this request. Please refer to Authentication for more.
{companyId}/serviceGroups/{groupId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
companyId |
string |
Company identifier. |
groupId |
string |
Group identifier. |
In the request body, supply a Group resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Optional Properties | ||
name |
string |
Name of the group. |
If successful, this method returns a Group resource in the response body.