Unipile icon

Unipile

Interact with Unipile API

Overview

The node interacts with the Unipile API to perform various operations on different resources. Specifically, for the "Account" resource and the "Restart Account" operation, it allows users to restart a specified account by providing its unique Account ID. This can be useful in scenarios where an account needs to be reset or refreshed programmatically, such as recovering from errors, applying new settings, or reinitializing connections.

Practical examples include:

  • Restarting a user account after configuration changes.
  • Automating account resets as part of maintenance workflows.
  • Triggering account restarts based on external events or conditions.

Properties

Name Meaning
Account ID The unique identifier of the account to restart. This is a required string input.

Output

The node outputs JSON data representing the response from the Unipile API after attempting to restart the specified account. The exact structure depends on the API's response but typically includes status information about the restart operation, such as success confirmation or error details.

If the node supports binary data output (not indicated here), it would represent any files or attachments returned by the API related to the account restart process.

Dependencies

  • Requires an active connection to the Unipile API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for the API is dynamically set from the credential's DSN (Data Source Name) property.
  • Proper network access to the Unipile service endpoint.

Troubleshooting

  • Common issues:

    • Invalid or missing Account ID will cause the operation to fail.
    • Authentication errors if the API key or token is incorrect or expired.
    • Network connectivity problems preventing access to the Unipile API.
    • API rate limits or permission restrictions may block the restart request.
  • Error messages:

    • "Unauthorized" or "Authentication failed": Check API credentials and renew if necessary.
    • "Account not found": Verify that the provided Account ID exists and is correct.
    • "Network error" or "Timeout": Ensure stable internet connection and API availability.
    • "Invalid input": Confirm that the Account ID is provided and formatted correctly.

Resolving these usually involves verifying input parameters, refreshing credentials, and ensuring proper network conditions.

Links and References

Discussion