Actions60
- User Actions
- Channel Actions
- Accept Invite
- Add Members
- Add Moderators
- Archive
- Ban User
- Create
- Delete
- Delete File
- Delete Image
- Demote Moderators
- Disable Slow Mode
- Enable Slow Mode
- Get Config
- Hide
- Invite Members
- Mark Read
- Mark Unread
- Mute
- Mute Status
- Pin
- Query Channels
- Query Members
- Reject Invite
- Remove Members
- Send Action
- Send File
- Send Image
- Show
- Stop Watching
- Truncate
- Unarchive
- Unban User
- Unmute
- Unpin
- Update
- Watch
- Message Actions
- Moderation Actions
Channel → Unpin
AI-generatedSummary
Unpin a channel for a specified user in Stream Chat, removing the pinned status from that channel.
Inputs
- Channel Type — The type of the channel to unpin, such as "messaging" (1-on-1 chats), "team" (group channels), or "livestream" (broadcast channels). Defaults to "messaging".
- Channel ID (required) — The unique identifier of the channel to unpin (e.g., "general", "random", "team-alpha"). Combined with the channel type to form the CID.
- User ID — The user ID for whom the channel should be unpinned. This is required for server-side unpin operations.
Output shape
a single record containing the response from the Stream Chat API about the unpin operation.
The output JSON contains the API response indicating the result of the unpin action. Errors are returned in the JSON as error messages if the operation fails.
Examples
Example 1: Unpin a 'messaging' type channel with ID 'general' for user 'john_doe'.
Set Channel Type to 'messaging', Channel ID to 'general', and User ID to 'john_doe'.