avanta icon

avanta

Consume avanta API

Actions57

Company - User → Create or Update

AI-generated

Overview

This node operation allows creating or updating a company user in the Avanta system. It supports setting various user details such as email, name, roles, and additional custom attributes. It is useful for managing user accounts within a company, including bulk processing and integration with dataflows.

Use Case Examples

  1. Creating a new company user with email, first name, last name, and assigned role.
  2. Updating an existing company user with additional custom attributes and subscription status.
  3. Bulk creating multiple company users using the bulk API option.

Properties

Name Meaning
Request Options Options to control API request behavior such as debug mode, SSL certificate validation, and request timeout.
Return to Webhook Whether to return the response to a webhook (requires a Respond to Webhook node).
Use Bulk API Whether to use the bulk API for processing multiple items.
Dataflow ID Optional override for the dataflow ID, used when triggered via a dataflow profile.
Company Customer ID The customer ID associated with the company user.
Company Role External Name or ID The external name or ID of the company role assigned to the user.
Email The email address of the company user.
Firstname The first name of the company user.
Lastname The last name of the company user.
Proline External Customer ID An external customer ID from Proline associated with the user.
Additional Fields Additional optional fields for the company user such as Amazon ID, confirmation, custom attributes, date of birth, billing/shipping addresses, gender, group, subscription status, password, sales organization, store, vertex customer code, and website.

Output

JSON

  • id - Unique identifier of the created or updated company user.
  • email - Email address of the company user.
  • firstname - First name of the company user.
  • lastname - Last name of the company user.
  • company_customer_id - Customer ID associated with the company user.
  • company_role_external_id - External ID or name of the company role assigned to the user.
  • additionalFields - Additional optional fields and custom attributes of the company user.

Dependencies

  • An API key credential for Avanta API authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has necessary permissions.
  • If using bulk API, verify that the input data format matches the expected structure for bulk processing.
  • Check that required fields like email and role are provided to avoid validation errors.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
  • Timeout errors can be resolved by increasing the timeout value in request options.

Discussion