Message: update / distributionList (app -> client)

Back to overview

Return a modified distribution list.

This message MUST be sent by the app in case the client's requested distribution list modification was successful.

Acknowledgement

This message acknowledges:

Message Condition Error Codes

update/distributionList (client -> app)

(None)

Name	Description
`badRequest`	Invalid request
`internalError`	An internal error occurred
`invalidDistributionList`	Distribution list not found
`noMembers`	Empty member list submitted
`valueTooLong`	The distribution list name is too long

Args

Field	Description	Type	Optional	Nullable
id	The distribution list id	String	False	False

Data

Field	Description	Type	Optional	Nullable
receiver	The modified distribution list	Map<DistributionList>	True	False

Models

DistributionList

Field	Description	Type	Optional	Nullable	Default
id	The distribution list id	String	False	False
displayName	The distribution list display name	String	False	False
color	The distribution list color in hex notation (e.g. `"#1122FF"`)	String	False	False
locked	Set to `true` if the chat is marked as a secret chat	Boolean	True	False	False
visible	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
access	The access object	Map<DistributionListReceiverAccess>	False	False

DistributionListReceiverAccess

Field	Description	Type	Optional	Nullable	Default
canDelete	Whether this distribution list can be deleted	Boolean	False	False
canChangeMembers	Whether the distribution list members can be changed	Boolean	False	False