Chatwork icon

Chatwork

Retrieve data from Chatwork API.

Overview

This node interacts with the Chatwork API to manage chatrooms and their members. Specifically, the "Change associated members" operation for the "Rooms" resource allows users to update the membership of a group chat by assigning different roles such as administrators, members, and read-only users.

Common scenarios where this node is beneficial include:

  • Managing team collaboration by dynamically updating who has admin rights or member access in a chatroom.
  • Automating user role changes in group chats based on project phases or organizational changes.
  • Synchronizing chatroom memberships with external systems or databases.

For example, you could use this node to promote certain users to administrators while demoting others to read-only status, ensuring proper permissions are maintained without manual intervention.

Properties

Name Meaning
Chatroom ID The unique numeric identifier of the chatroom to update.
Group Chat Administrators Comma-separated list of user IDs to be assigned administrator permissions. At least one must be specified.
Group Chat Members Comma-separated list of user IDs to be assigned member permissions.
Group Chat Read-only Users Comma-separated list of user IDs to be assigned read-only permissions.

Output

The output is a JSON object representing the response from the Chatwork API after attempting to change the associated members of the specified chatroom. This typically includes confirmation of the updated membership details or any error messages returned by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Chatwork API using a valid API authentication token configured in n8n credentials.
  • The node depends on the chatworkApiRequest helper function to make HTTP requests to the Chatwork API endpoints.

Troubleshooting

  • Missing or invalid Chatroom ID: Ensure that the Chatroom ID provided is correct and corresponds to an existing chatroom.
  • At least one administrator required: The API requires at least one user ID in the administrators list; omitting this will cause an error.
  • Invalid user IDs format: User IDs should be provided as comma-separated strings without spaces or invalid characters.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Unsupported operations or resources: If the operation or resource name is incorrect or unsupported, the node will throw an error indicating this.

Links and References

Discussion