Update via groupId

Update a Group object by id

Parameter

Accessible via URL https://api.channel.io/open/v5/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/v5/group/1234?botName=channelBot

Update via groupName

Update a Group object by name

Parameter

Accessible via URL https://api.channel.io/open/v5/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/v5/group/@justGroup?botName=channelBot

Your PATCH request body should look like

{
   "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",
      "name": "string",
      "description": "string",
      "showDescriptionToFront": true,
      "nameDescI18nMap": {
        "additionalProp1": {
          "name": "string",
          "description": "string"
        },
        "additionalProp2": {
          "name": "string",
          "description": "string"
        },
        "additionalProp3": {
          "name": "string",
          "description": "string"
        }
      },
      "profile": {
        "name": "string",
        "empty": true,
        "email": "string",
        "avatarUrl": "string",
        "mobileNumber": "string",
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      },
      "email": "string",
      "showEmailToFront": true,
      "mobileNumber": "string",
      "showMobileNumberToFront": true,
      "role": "owner",
      "removed": true,
      "createdAt": 1656032151480,
      "displayAsChannel": true,
      "defaultGroupWatch": "all",
      "defaultDirectChatWatch": "all",
      "defaultUserChatWatch": "all",
      "chatAlertSound": "none",
      "showPrivateMessagePreview": true,
      "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
          }
        ]
      },
      "defaultAllMentionImportant": true,
      "userMessageImportant": true,
      "autoAssignCapacity": 0,
      "statusEmoji": "string",
      "statusText": "string",
      "statusClearAt": 1656032151487,
      "doNotDisturbClearAt": 1656032151487,
      "doNotDisturb": true,
      "avatarUrl": "string",
      "managerId": "string",
      "emailForFront": "string",
      "mobileNumberForFront": "string"
    }
  ],
  "onlines": [
    {
      "channelId": "string",
      "personType": "string",
      "personId": "string",
      "id": "string"
    }
  ],
  "bookmark": {
    "key": "string",
    "chatId": "string",
    "chatKey": "string",
    "bookmarkKey": "string",
    "channelId": "string",
    "version": 0,
    "personType": "string",
    "personId": "string",
    "chatType": "string"
  },
  "session": {
    "key": "string",
    "chatId": "string",
    "chatKey": "string",
    "updatedKey": "string",
    "unreadKey": "string",
    "channelId": "string",
    "alert": 0,
    "unread": 0,
    "watch": "all",
    "allMentionImportant": true,
    "readAt": 1656032152418,
    "receivedAt": 1656032152418,
    "postedAt": 1656032152418,
    "updatedAt": 1656032152427,
    "createdAt": 1656032152427,
    "version": 0,
    "id": "string",
    "personType": "string",
    "personId": "string",
    "chatType": "string"
  },
  "group": {
    "id": "string",
    "channelId": "string",
    "name": "string",
    "scope": "all",
    "managerIds": [
      "string"
    ],
    "icon": "string",
    "description": "string",
    "createdAt": 1656032149398,
    "updatedAt": 1656032149399,
    "active": true
  }
}