GymControl icon

GymControl

Handle your GymControl instance

Actions91

Overview

The node integrates with the GymControl API to update existing notification topics. It allows users to modify the name and description of a specific topic identified by its ID. This is useful in scenarios where you want to keep your notification topics up-to-date, for example, when renaming a topic to better reflect its purpose or updating its description to provide clearer information.

Practical examples include:

  • Renaming a notification topic from "Monthly Updates" to "Monthly Newsletters".
  • Adding or changing the description of a topic to clarify what kind of notifications it covers.

Properties

Name Meaning
Show Complete Response Boolean flag to determine if the full API response should be returned by the node.
ID The unique identifier of the topic to update.
Options Collection of optional fields to update:
- Name New name for the topic.
- Description New description text for the topic (multi-line).

Output

The node outputs JSON data representing the updated topic as returned by the GymControl API. If "Show Complete Response" is enabled, the entire API response is returned; otherwise, only relevant parts are output.

The output JSON typically includes the updated topic's properties such as its ID, name, description, and possibly other metadata related to the topic.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating requests to the GymControl API.
  • The base URL for the API is configured via credentials.
  • The node makes HTTP PUT requests to the endpoint /notification/topics/{id} to perform updates.

Troubleshooting

  • Invalid or missing ID: The node requires a valid topic ID to update. Ensure the ID corresponds to an existing topic.
  • Authentication errors: Verify that the API key credential is correctly set and has sufficient permissions.
  • Empty update fields: If neither name nor description is provided in options, the API may reject the request or make no changes.
  • API connectivity issues: Check network access to the GymControl API URL.
  • Unexpected API responses: Enable "Show Complete Response" to debug the full response from the API.

Links and References

  • GymControl API documentation (for notification topics): GymControl API Docs (hypothetical link)

Discussion