Invites

Invites allow you to add users to a channel with a pending state. The invited user receives a notification and can accept or reject the invite.

Unread counts are not incremented for channels with a pending invite.

Invite Users

from getstream.models import ChannelMemberRequest

# Get a channel
channel = client.chat.channel("messaging", "general")

channel.update(invites=[ChannelMemberRequest(user_id="thierry")])

Accept an Invite

Call acceptInvite to accept a pending invite. You can optionally include a message parameter to post a system message when the user joins (e.g., "Nick joined this channel!").

channel.update(accept_invite=True, user_id="thierry")

Reject an Invite

Call rejectInvite to decline a pending invite. Client-side calls use the currently connected user. Server-side calls require a user_id parameter.

channel.update(reject_invite=True, user_id="thierry")

Query Invites by Status

Use queryChannels with the invite filter to retrieve channels based on invite status. Valid values are pending, accepted, and rejected.

Query Accepted Invites

client.chat.query_channels(filter_conditions={"invite": "accepted"})

Query Rejected Invites

client.chat.query_channels(filter_conditions={"invite": "rejected"})

Query Pending Invites

client.chat.query_channels(filter_conditions={"invite": "pending"})