Stream Chat

Overview

The "Unshadow Ban User" operation in the Moderation resource of this node removes a shadow ban from a specified user in the Stream Chat platform. Shadow banning is a moderation technique where a user’s messages and activities are hidden from others without their knowledge. Removing a shadow ban restores the user's visibility and normal interaction within the chat environment.

This operation is useful in scenarios where a moderator or administrator decides to reinstate a previously shadow-banned user, allowing them to participate openly again. For example, after reviewing a user's behavior or upon appeal, the moderator can use this operation to lift the shadow ban.

Properties

Output

The output JSON contains the response from the Stream Chat API after attempting to remove the shadow ban on the specified user. This typically includes confirmation details about the unshadow ban action or any relevant metadata returned by the API.

No binary data is output by this operation.

Example output structure (simplified):

{
  "json": {
    "status": "success",
    "user_id": "targetUserId",
    "message": "Shadow ban removed"
  }
}

(Note: Actual output fields depend on the Stream Chat API response.)

Dependencies

• Requires an active connection to the Stream Chat service via an API key credential configured in n8n.
• The API credentials must have sufficient permissions to perform moderation actions such as removing shadow bans.
• No additional external dependencies beyond the Stream Chat API.

Troubleshooting

• Common Issues:

  • Invalid or missing Target User ID: Ensure the user ID provided exists and is correctly formatted.
  • Insufficient permissions: The API key used must have moderation rights; otherwise, the operation will fail.
  • Network or API errors: Temporary connectivity issues with Stream Chat may cause failures.

• Error Messages:

  • "Unsupported operation: moderation.removeShadowBan": Indicates the operation is not recognized; verify the node version supports this operation.
  • API error messages related to authorization or invalid user IDs will be passed through; check the message for specifics.

• Resolution Tips:

  • Double-check the Target User ID input.
  • Verify API credentials and permissions.
  • Retry after some time if encountering transient network errors.

Links and References

• Stream Chat Moderation API Documentation
• Stream Chat Shadow Banning Concept
• n8n Documentation on Credentials