avanta icon

avanta

Consume avanta API

Actions57

Company - Role → Create or Update

AI-generated

Overview

This node handles the creation or updating of company roles within the Avanta API. It is useful for managing roles associated with companies, such as defining system roles, assigning external IDs, and setting permissions. Practical applications include automating role management in company workflows, integrating role data from external systems, and bulk processing of role data.

Use Case Examples

  1. Creating a new company role with specific permissions and linking it to a parent role.
  2. Updating an existing company role's name or type based on external system data.

Properties

Name Meaning
Request Options Options to configure the API request such as enabling debug mode, ignoring SSL issues, and setting request timeout.
Return to Webhook Whether to return the response to a webhook (only for create operation).
Use Bulk API Whether to use the bulk API for processing multiple items (applicable to create operation).
Dataflow ID Optional override for the dataflow ID, used when triggered via a dataflow profile (applicable when bulk API is used).
Company Customer ID Customer ID of the company (required).
Store Group ID Store Group ID of the company (required).
Is System Indicates if the company role is a system role (required).
External Parent ID External ID of the parent company role (required).
Role Name Name of the company role (required).
External ID External ID of the company role.
Role Type Type of the company role (required).
Company Rules Type Method to add resources to the company role: none, mapping via fields, or raw JSON.
Company Rules Collection of resources with permissions to add to the company role when using 'Fields Below' option.
Company Rules JSON Raw JSON to add resources dynamically when using the JSON option for company rules.

Output

JSON

  • id - Identifier of the created or updated company role.
  • role_name - Name of the company role.
  • role_type - Type of the company role.
  • external_id - External identifier of the company role.
  • is_system - Indicates if the role is a system role.
  • parent_id - External ID of the parent company role.
  • customer_id - Customer ID of the company.
  • store_group_id - Store Group ID of the company.
  • company_rules - Resources and permissions associated with the company role.

Dependencies

  • An API key credential for authenticating with the Avanta API.

Troubleshooting

  • Ensure all required fields (e.g., customer_id, store_group_id, role_name, role_type) are provided to avoid validation errors.
  • If using the bulk API, verify that the dataflow ID is correctly set or available in the webhook input data.
  • Enable debug mode to get detailed API request information if the node fails to execute as expected.
  • Check SSL settings if connection issues occur, especially if ignoring SSL issues is disabled.

Discussion