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 Provision resource with the Update operation, it updates an existing provision record identified by its unique ID. This is useful in scenarios where you need to modify provisioning details dynamically, such as updating configuration parameters or attributes of a telephony provision.

Practical example: You have a provision entry representing a telephony service setup, and you want to update certain fields (like name or other custom attributes) without recreating the entire provision. This node allows you to specify the provision ID and the fields to update, sending the changes directly to the TeleFlow API.

Properties

Name Meaning
ID The unique identifier of the provision resource to update. Must be provided.
Fields A collection of field-value pairs specifying which fields to update and their new values.
  • ID is required to identify which provision record to update.
  • Fields allows adding multiple key-value pairs to specify exactly what data should be updated on the provision.

Output

The output is an array of JSON objects, each representing the response from the TeleFlow API after attempting to update a provision. The structure corresponds to the updated provision resource as returned by the API.

Example output JSON structure:

{
  "id": "string",
  "name": "string",
  "otherUpdatedField1": "value",
  "otherUpdatedField2": "value"
}

No binary data output is produced by this node.

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 PUT requests to update resources via the TeleFlow REST API.

Troubleshooting

  • Missing ID error: If the ID property is not set when performing an update, the node will throw an error stating that the ID is required. Ensure the ID is correctly provided.
  • API request failures: Network issues, invalid credentials, or incorrect field names can cause the API request to fail. Check the API key validity, network connectivity, and ensure the fields being updated exist and are allowed by the API.
  • Partial updates: Only fields specified in the "Fields" collection are sent for update. Omitting required fields may lead to incomplete updates or errors.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one update fails, returning error details in the output JSON.

Links and References

Discussion