Message: update / group (app -> client)

Back to overview

Return a modified group.

This message MUST be sent by the app after all associated group control messages have been successfully delivered to the server.

Acknowledgement

This message acknowledges:

Message Condition Error Codes
update/group (client -> app)

(None)

Name Description
badRequest

Invalid request

internalError

An internal error occurred

invalidGroup

Group not found

noMembers

Empty member list submitted

notAllowed

Only the admin is allowed to change a group

valueTooLong

The group name is too long

Args

Field Description Type Optional Nullable
id

The group id

String False False

Data

Field Description Type Optional Nullable
receiver

The modified group

Map<Group> True False

Models

Group

Field Description Type Optional Nullable Default
id

The group identity

String False False
name

The group name (max 256 bytes)

String True False
displayName

The group display name

String False False
color

The group color in hex notation (e.g. "#1122FF")

String False False
createdAt

The group creation date as a unix time stamp in seconds

Integer False False
disabled

This is set to true if the user is not a member of this group anymore

Boolean True False False
locked

This is set to true if the chat is marked as a secret chat

Boolean True False False
visible

This is set to false if the chat is marked as a secret chat and if secret chats are hidden in the app

Boolean True False True
members

The list of group member identities

Array<String> False False
administrator

The identity of the group admin

String False False
access

The access object

Map<GroupReceiverAccess> False False

GroupReceiverAccess

Field Description Type Optional Nullable Default
canDelete

Whether this group can be deleted

Boolean False False
canChangeAvatar

Whether the group avatar can be changed

Boolean False False
canChangeName

Whether the group name can be changed

Boolean False False
canChangeMembers

Whether the group members can be changed

Boolean False False
canLeave

Whether this group can be left

Boolean False False
canSync

Whether the group can be re-synced

Boolean False False