Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Accept Invite

AI-generated

Summary

Accept a pending invitation to join a specified Stream Chat channel using the channel's type and unique identifier.

Inputs

  • Channel Type — Specify the type of the channel (e.g., "messaging" for 1-on-1 chats, "team" for group channels, "livestream" for broadcast channels). Defaults to "messaging".
  • Channel ID (required) — Provide the unique identifier for the channel (e.g., "general", "random", "team-alpha"). Combined with the channel type to form the channel CID.

Output shape

a single JSON object representing the result of accepting the invite for the specified channel

The operation returns the response from Stream Chat's acceptInvite API call on the channel. If an error occurs, the output will contain an error message. The output does not include pagination or multiple items.

Examples

Example 1: Accept the invite to a 'messaging' channel with ID 'general'

Set Channel Type to 'messaging' and Channel ID to 'general', then execute to accept the invitation to that channel.

Discussion