Chatwork icon

Chatwork

Retrieve data from Chatwork API.

Overview

This node integrates with the Chatwork API to update information about chat rooms. Specifically, the "Update info" operation under the "Rooms" resource allows users to modify details of an existing group chat such as its name, description, and icon type.

Common scenarios where this node is beneficial include:

  • Renaming a project or team chatroom to reflect updated project titles.
  • Updating the description to provide clearer context or instructions for chat members.
  • Changing the chatroom icon to better represent the group's purpose or status.

For example, a marketing team might rename their chatroom from "Q1 Campaign" to "Q2 Campaign" and update the description to include new campaign goals.

Properties

Name Meaning
Chatroom ID The unique numeric identifier of the chatroom to update.
Group chat name The new title/name for the group chat.
Chat description A textual description providing details about the group chat.
Icon type The icon representing the group chat. Options include: group, check, document, meeting, event, project, business, study, security, star, idea, heart, magcup, beer, music, sports, travel.

Output

The node outputs JSON data representing the updated chatroom information returned by the Chatwork API after the update operation. This typically includes fields reflecting the current state of the chatroom such as its ID, name, description, icon type, and possibly other metadata.

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

  • Invalid Chatroom ID: If the provided Chatroom ID does not exist or is incorrect, the API will likely return an error indicating the room was not found. Verify the ID before running the node.
  • Insufficient Permissions: Updating room info requires appropriate permissions. Errors related to authorization may occur if the API token lacks rights to modify the specified room.
  • Missing Required Fields: While the Chatroom ID is required, the name and description are optional but at least one should be provided to effect a meaningful update.
  • Unsupported Icon Type: Ensure the icon type value matches one of the predefined options; otherwise, the API may reject the request.

Links and References

Discussion