PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)
Join our community

Actions34

Overview

This node allows you to add an alias to an Account resource in PortaOne via its API. It supports both Token and Basic authentication methods. The node is useful for automating account management tasks, such as associating additional identifiers (aliases) with existing accounts. Typical scenarios include telecom service providers managing customer accounts, updating account roles, or linking DID numbers.

Example use cases:

  • Assigning a new alias to a customer account for easier identification.
  • Linking a DID number to an account for call routing.
  • Updating account roles or blocking calls for specific accounts.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
AdditionalFields A collection of optional fields to further specify the alias being added:
- Blocked: Indicates whether a customer's calls should be blocked (Yes/No)
- Account ID: The unique ID of the account record.
- Account Role ID
- DID Number ID: The unique ID of the DID number record
- Master Account ID
- ID: The subject's ID
- Realm: The realm is the way to group accounts by the scope of uniqueness
Simplify Whether to simplify the output data. If enabled, the response will be reduced to essential information.
SimplifyPath Path to the property that should be returned when simplifying output.

Output

  • The node outputs a json field containing the result of the "Add Alias" operation.
  • If "Simplify" is enabled, only the specified path (if provided) or simplified data will be returned.
  • The structure of the output depends on the API response from PortaOne, but typically includes details about the newly added alias and any related account information.
  • Binary data: This node does not output binary data.

Dependencies

  • External Services: Requires access to the PortaOne API.
  • API Credentials: You must configure either a PortaOne Token API credential or a PortaOne Basic API credential in n8n, depending on your selected authentication method.
  • n8n Configuration: Ensure the relevant credentials are set up in your n8n instance.

Troubleshooting

  • Authentication Errors:
    • Error message: "Invalid credentials" or "Authentication failed".
      Resolution: Check that the correct authentication method is selected and valid credentials are provided in n8n.
  • Missing Required Fields:
    • Error message: "Missing required parameter" or similar.
      Resolution: Ensure all necessary fields (such as Account ID or DID Number ID) are filled in under AdditionalFields.
  • API Connection Issues:
    • Error message: "Unable to connect to PortaOne API".
      Resolution: Verify network connectivity and that the PortaOne API endpoint is accessible from your n8n instance.

Links and References

Discussion