TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

The node interacts with the TeleFlow API to perform various operations on different resources. Specifically, for the Tenant Audit resource with the Update operation, it updates an existing tenant audit record by its unique ID. This is useful in scenarios where you need to modify audit details related to tenants, such as updating audit metadata or correcting information.

Practical example: If your system tracks tenant activities and you want to update specific audit fields (like status or notes) after an event review, this node can send the updated data to TeleFlow's API seamlessly.

Properties

Name Meaning
ID The unique identifier of the Tenant Audit record to update. This is required.
Fields A collection of field-value pairs specifying which fields to include or update in the request. Each pair consists of a field name and its corresponding value.

Note: For the Update operation, the node expects the ID and relevant fields to update. However, based on the bundled code, the "fields" property is not directly used in the update logic for Tenant Audit; instead, the update payload depends on the resource type. Since Tenant Audit is not explicitly handled in the update payload construction, it likely sends an empty or minimal body unless extended.

Output

The output is an array containing one item per input item processed. Each output item has a json property holding the response from the TeleFlow API:

  • For the Update operation on Tenant Audit, the json output contains the updated tenant audit record as returned by the API.
  • No binary data output is produced by this node.

Example output structure:

{
  "json": {
    "id": "string",
    "updatedFields": {
      "fieldName": "newValue"
    },
    "status": "success"
  }
}

(Note: Actual fields depend on the TeleFlow API response.)

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The base URL for the API must be configured in the node credentials.
  • The node uses HTTP requests with JSON content type and expects JSON responses.

Troubleshooting

  • Missing ID error: The node throws an error if the ID parameter is missing when performing the update operation. Ensure the ID is provided.
  • API errors: If the API returns an error (e.g., invalid fields, unauthorized), the node will throw an error unless "Continue On Fail" is enabled, in which case the error message is included in the output JSON.
  • Empty update payload: Since the update payload for Tenant Audit is not explicitly constructed in the code, updates may fail or have no effect if no fields are specified. Verify that the API supports partial updates or adjust the node to send appropriate fields.
  • Credential issues: Ensure the API key and base URL are correctly set in the node credentials to avoid authentication failures.

Links and References

Discussion