Type Alias LeaveGroupRequest

LeaveGroup request payload.

type LeaveGroupRequest = {
    groupId: string;
    memberId?: string;
    members?: readonly LeaveGroupMemberRequest[];
    taggedFields?: readonly TaggedField[];
}

Index

Properties

groupId memberId? members? taggedFields?

Properties

`Readonly`groupId

groupId: string

The group ID.

`Optional` `Readonly`memberId

memberId?: string

The member ID (v0–v2 single-member leave).

`Optional` `Readonly`members

members?: readonly LeaveGroupMemberRequest[]

Members leaving the group (v3+ batched leave).

`Optional` `Readonly`taggedFields

taggedFields?: readonly TaggedField[]

Tagged fields (v4+).