Chatwork icon

Chatwork

Retrieve data from Chatwork API.

Overview

This node interacts with the Chatwork API to update information about a chatroom (referred to as "Rooms" resource, specifically the "Update info" operation). It allows users to modify key details of an existing group chat such as its name, description, and icon type. This is useful for keeping chatroom metadata current, reflecting changes in project names, purposes, or visual identifiers.

Practical examples include:

  • Renaming a project chatroom after a rebranding.
  • Updating the description to clarify the chatroom’s purpose.
  • Changing the icon to better represent the chatroom’s theme or status.

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 more 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 output is a JSON object representing the updated chatroom information returned from the Chatwork API. This typically includes the updated fields such as the chatroom's ID, name, description, icon type, and possibly other metadata related to the room.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Chatwork API.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The node uses HTTP PUT method to send updates to the /rooms/{roomId} endpoint of the Chatwork API.

Troubleshooting

  • Common issues:

    • Invalid or missing Chatroom ID will cause the API request to fail.
    • Insufficient permissions or invalid API token may result in authorization errors.
    • Providing empty or invalid values for required fields might lead to API validation errors.
  • Error messages:

    • "operation is not supported." — indicates that the specified operation is not implemented; ensure "Update info" is selected.
    • "resource is not supported." — means the resource parameter is incorrect; verify "Rooms" is chosen.
    • API errors related to HTTP status codes (e.g., 400 Bad Request, 401 Unauthorized) should be checked by reviewing the input parameters and API credentials.

Links and References

Discussion