avanta icon

avanta

Consume avanta API

Actions8

Overview

This node interacts with the "CompanyUser" resource of the Avanta API, specifically supporting the creation and updating of company user records. It is designed to facilitate managing users associated with companies, including their roles, contact details, and various custom attributes.

Common scenarios where this node is beneficial include:

  • Automating the onboarding of new company users by creating their profiles in bulk or individually.
  • Updating existing company user information such as email, name, role, or subscription status.
  • Integrating user management workflows with other systems via webhook responses.

Practical examples:

  • Creating multiple company users at once using the Bulk API option for efficiency.
  • Assigning specific roles to users based on external role IDs.
  • Adding custom attributes or additional fields like date of birth, gender, or subscription status during user creation or update.

Properties

Name Meaning
Return to Webhook Boolean flag indicating if a 'Respond to Webhook' node should be used after this node to return the response.
Use Bulk API Boolean flag (only for create operation) to determine whether to use the Bulk API for creating multiple users efficiently.
Company Customer ID String identifier for the customer within the company context.
Company Role External Name or ID Selectable option or expression to specify the external name or ID of the company role assigned to the user.
Email User's email address.
Firstname User's first name.
Lastname User's last name.
Proline External Customer ID External customer ID related to Proline system.
Additional Fields A collection of optional fields to provide more detailed user information:
- Amazon ID String representing an Amazon-specific identifier.
- Confirmation String field for confirmation data.
- Custom Attributes Multiple custom attribute entries, each with an attribute code name or ID and a corresponding value.
- Date of Birth Date/time field specifying the user's birth date.
- Default Billing Address ID String ID for the default billing address.
- Default Shipping Address ID String ID for the default shipping address.
- Gender Option to select gender: Male, Female, or Not Specified.
- Group Name or ID Selectable group name or ID to which the user belongs.
- Is Subscribed Boolean indicating if the user is subscribed (e.g., to newsletters).
- Middle Name User's middle name.
- Password Password string for the user account (input masked).
- Prefix Name prefix (e.g., Mr., Ms.).
- Store Name or ID Selectable store name or ID associated with the user.
- Suffix Name suffix (e.g., Jr., Sr.).
- Vertex Customer Code String code related to Vertex customer identification.
- Vertex Customer Country String specifying the country for Vertex customer.
- Website Name or ID Selectable website name or ID associated with the user (only for create operation).
- Sales Org String representing the sales organization.

Output

The node outputs JSON data representing the created or updated company user(s). The structure typically includes all relevant user details as accepted by the API, reflecting the input properties and any additional data returned by the Avanta API.

If the "Return to Webhook" property is enabled, the output is intended to be sent back through a webhook response node, facilitating synchronous workflows.

No binary data output is indicated for this node.

Dependencies

  • Requires an API key credential for authenticating with the Avanta API.
  • Uses the Avanta API endpoints for company user management.
  • For dynamic options (e.g., roles, groups, stores, websites), it relies on internal methods to load these options from the API.
  • If using the Bulk API option, the node depends on the Avanta Bulk API support for efficient batch processing.

Troubleshooting

  • Missing or invalid API credentials: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Invalid role, group, store, or website IDs: When selecting from dropdowns or using expressions, verify that the IDs correspond to existing entities in Avanta.
  • Bulk API failures: If bulk creation fails, try disabling the Bulk API option to isolate issues with individual records.
  • Webhook response errors: If "Return to Webhook" is enabled but no subsequent 'Respond to Webhook' node exists, the workflow may fail or hang; always pair with a proper webhook response node.
  • Validation errors: Check required fields like email and role are provided and correctly formatted.

Links and References

Discussion