Update a Group
Update via groupId
Update a Group
object by id
Parameter
Accessible via URL https://api.channel.io/open/v3/group/{groupId}
and HTTP PATCH
Example
PATCH https://api.channel.io/open/v3/group/1234
This method accepts
application/json
Parameter | Example | Required | Description | Parameter Type |
---|---|---|---|---|
groupId | 1234 | Required | Id of | Path |
Update via groupName
Update a Group
object by name
Parameter
Accessible via URL https://api.channel.io/open/v3/group/@{groupName}
and HTTP PATCH
Example
PATCH https://api.channel.io/open/v3/group/@justGroup
This method accepts
application/json
Parameter | Example | Required | Description | Parameter Type |
---|---|---|---|---|
groupName | justGroup | Required | Name of | Path |
Your PATCH request body should look like
{
"name": "String",
"icon": "String",
"description": "String"
}
Response
Returns a Group
object with additional information.
{
"group": {
"id": "1234",
"channelId": "String",
"name": "justGroup",
"scope": "String",
"managerIds": ["1", "2", "3", "4"],
"icon": "String",
"description": "String",
"createdAt": 1527207802758,
"updatedAt": 1527207802758,
},
"managers": [
{
"id": "String",
"channelId": "String",
"accountId": "String",
"username": "String",
"name": "String",
"email": "String",
"language": "String",
"mobileNumber": "String",
"role": "String",
"removed": Boolean,
"createdAt": 1456287185507,
"defaultWatch": "String",
"operator": Boolean,
"operatorScore": Float,
"watchOpenUserChatViaEmail": Boolean,
"watchOpenUserChatViaMobile": Boolean,
"avatarUrl": "String",
"systemLanguage": "String"
},
...
{
...
}
]
}
Updated almost 2 years ago