Bookla icon

Bookla

Get data from Bookla's API
Join our community

Actions12

Overview

The node integrates with the Bookla API to update details of a service within a specified company. It allows users to modify attributes such as the service's name, color, and metadata. This is useful in scenarios where service information needs to be kept current or customized dynamically, for example, updating a service's display name or adjusting metadata related to scheduling or categorization.

Practical examples:

  • Renaming a service after rebranding.
  • Changing the color code used in calendars or UI elements.
  • Updating nested metadata fields to reflect new business rules or configurations.

Properties

Name Meaning
Server Select which Bookla server to connect to: "US Server" or "EU Server".
Company ID The unique identifier of the company owning the service (required).
Service ID The unique identifier of the service to update (required).
Name New name for the service.
Color New color value for the service, typically used for UI representation.
Meta Data Object to update nested metadata fields with:
  Expected Version Number indicating the expected version of the metadata for concurrency control.
  Path String path specifying the location within the metadata object to update.
  Value JSON value to set at the specified path. Can be any valid JSON structure.

Output

The node outputs the JSON response from the Bookla API after performing the update operation on the service. This JSON typically contains the updated service data reflecting the changes made.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating requests to the Bookla API.
  • The node uses the selected server domain (us.bookla.com or eu.bookla.com) based on the "Server" property.
  • Proper network access to the Bookla API endpoints is necessary.

Troubleshooting

  • Invalid Company ID or Service ID: If these identifiers are incorrect or do not exist, the API will return errors indicating resource not found. Verify IDs before running the node.
  • Metadata Update Errors: Providing an incorrect path or invalid JSON in the metadata update can cause failures. Ensure the JSON is well-formed and the path exists in the metadata structure.
  • Version Conflicts: The "Expected Version" field helps prevent concurrent modification conflicts. If the version does not match the current metadata version, the update may fail. Retrieve the latest version before updating.
  • Authentication Failures: Missing or invalid API credentials will result in authorization errors. Confirm that the API key credential is correctly configured.
  • Server Selection: Choosing the wrong server (US vs EU) may lead to connection issues or unexpected data. Confirm the correct server for your company.

Links and References

Discussion