PortaOneInstall

Overview

The PortaOne node for n8n enables you to update account information in a PortaOne system. This node is designed for scenarios where you need to automate the management of customer accounts, such as updating user details, changing billing status, modifying service features, or managing associated resources like DID numbers and SIM cards.

Common use cases:

• Automating customer onboarding by updating account records with new information.
• Managing account statuses (e.g., suspending, activating, or closing accounts).
• Updating billing models, credit limits, or contact information.
• Modifying service features or assigning/removing DIDs and SIM cards.

Practical example:
When a customer updates their address or contact information via your web portal, you can use this node to automatically synchronize those changes with your PortaOne backend.

Properties

Key fields within "Account Info" include (not exhaustive):

• Account Expired, Account Inactive, Activate Date, Address Line 1/2, Alias Did Number List, Aux Fields, Balance, Batch Name, Bill Status, Billing Model, Blocked, Call Processing Mode Info, City, Companyname, Contact Persons, Control Numbers, Country, Credit Limit, Customer Bill Status, Customer Name, Customer Status, DID Number, Ecommerce Enabled, Email, Expiration Date, Extension ID/Name, Fax Number, First Usage, Last Usage, Login, Note, Notepad, Opening Balance, Password, Phone Numbers, Product Name, Realm, Redirect Number, Service Features, Sim Card Info, SIP Agent/Contact/Status, Site Name, State, Status, Subscriber Email, Time Zone, Voucher Info, Zero Balance, Zip, etc.

Many fields are collections or have multiple options (e.g., Yes/No, Open/Suspended/Closed, etc.).

Output

• The node returns a JSON object reflecting the result of the account update operation.
• If Simplify is enabled, the output will contain only the property specified by SimplifyPath, or a simplified version of the response.
• Otherwise, the full API response from PortaOne is returned, which typically includes:
  • Updated account details
  • Status of the operation
  • Any error messages if the update failed

Example output (simplified):

{
  "success": true,
  "i_account": 12345,
  "status": "updated",
  "details": {
    "customer_name": "John Doe",
    "email": "john.doe@example.com"
  }
}

Binary Data:
This node does not output binary data; all outputs are in JSON format.

Dependencies

• External Services: Requires access to a PortaOne instance with API enabled.
• API Credentials: You must provide either a PortaOne Token or Basic Auth credentials, depending on the selected authentication method.
• n8n Configuration: Ensure the appropriate credentials are set up in n8n under "portaOneTokenApi" or "portaOneBasicApi".

Troubleshooting

Common Issues:

• Authentication errors:

  • Error message: "Invalid credentials" or "Authentication failed".
    Resolution: Check that the correct authentication method and valid credentials are provided in n8n.

• Missing required fields:

  • Error message: "Missing required parameter: i_account" or similar.
    Resolution: Ensure all mandatory fields (such as Account ID) are filled in the "Account Info" collection.

• Invalid field values:

  • Error message: "Invalid value for field X".
    Resolution: Double-check the allowed options for each field (e.g., status codes, yes/no values).

• API connectivity issues:

  • Error message: "Unable to reach PortaOne API endpoint".
    Resolution: Verify network connectivity and that the PortaOne API URL is accessible from your n8n instance.

Links and References

• PortaOne Official Documentation
• n8n Documentation: Creating and Using Nodes
• ISO 3166-1 alpha-2 country codes
• ISO 4217 currency codes