Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Reject Invite

AI-generated

Summary

Reject a pending invitation to join a Stream Chat channel for the specified channel type and ID.

Inputs

  • Channel Type — Type of the channel, such as "messaging" for 1-on-1 chats, "team" for group channels, or "livestream" for broadcast channels; defaults to "messaging".
  • Channel ID (required) — Unique identifier of the channel (e.g., "general", "random", "team-alpha") to reject the invitation from.

Output shape

a single JSON object representing the result of the reject invite action

Returns the API response indicating success or failure of rejecting the channel invite; no pagination or additional optional fields are involved.

Examples

Example 1: Reject an invitation to a 'messaging' type channel with ID 'general'

Set Channel Type to 'messaging' and Channel ID to 'general'

Discussion