Update a Group

Update via groupId

Update a Group object by id

Parameter

Accessible via URL https://api.channel.io/open/v4/group/{groupId} and HTTP PATCH

📘

This method accepts application/json

Parameter

Example

Required

Description

Parameter Type

groupId

1234

Required

Id of Group object

Path

botName

channelBot

Optional

Name of the Bot that sends the message

Query

Example

PATCH https://api.channel.io/open/v4/group/1234?botName=channelBot

Update via groupName

Update a Group object by name

Parameter

Accessible via URL https://api.channel.io/open/v4/group/@{groupName} and HTTP PATCH

📘

This method accepts application/json

Parameter

Example

Required

Description

Parameter Type

groupName

justGroup

Required

Name of Group object

Path

botName

channelBot

Optional

Name of the Bot that sends the message

Query

Example

PATCH https://api.channel.io/open/v4/group/@justGroup?botName=channelBot

Your PATCH request body should look like

{
  "vanilla": {
    "name": "string",
    "scope": "all",
    "icon": "string",
    "description": "string",
    "active": true
  }
}

Response

Returns a Group object with additional information.

{
  "managers": [
    {
      "id": "string",
      "channelId": "string",
      "accountId": "string",
      "username": "string",
      "name": "string",
      "description": "string",
      "email": "string",
      "mobileNumber": "string",
      "role": "owner",
      "removed": true,
      "createdAt": 1624422361892,
      "defaultGroupWatch": "all",
      "defaultDirectChatWatch": "all",
      "defaultUserChatWatch": "all",
      "operatorScore": 0,
      "touchScore": 0,
      "avatar": {
        "bucket": "string",
        "key": "string",
        "width": 0,
        "height": 0
      },
      "operatorEmailReminder": true,
      "operator": true,
      "operatorScheduling": true,
      "operatorTimeRanges": {
        "timeRanges": [
          {
            "dayOfWeeks": [
              "mon"
            ],
            "from": 0,
            "to": 0
          }
        ]
      },
      "avatarUrl": "string",
      "managerId": "string"
    }
  ],
  "onlines": [
    {
      "channelId": "string",
      "personType": "string",
      "personId": "string",
      "id": "string"
    }
  ],
  "bookmark": {
    "key": "string",
    "chatId": "string",
    "chatKey": "string",
    "bookmarkKey": "string",
    "channelId": "string",
    "version": 0,
    "chatType": "string",
    "personType": "string",
    "personId": "string"
  },
  "session": {
    "key": "string",
    "chatId": "string",
    "chatKey": "string",
    "updatedKey": "string",
    "unreadKey": "string",
    "channelId": "string",
    "alert": 0,
    "unread": 0,
    "watch": "all",
    "readAt": 1624422354163,
    "receivedAt": 1624422354163,
    "postedAt": 1624422354163,
    "updatedAt": 1624422354079,
    "createdAt": 1624422354055,
    "version": 0,
    "id": "string",
    "chatType": "string",
    "personType": "string",
    "personId": "string"
  },
  "group": {
    "id": "string",
    "channelId": "string",
    "name": "string",
    "scope": "all",
    "managerIds": [
      "string"
    ],
    "icon": "string",
    "description": "string",
    "createdAt": 1624422348044,
    "updatedAt": 1624422348044,
    "active": true
  }
}