avanta icon

avanta

Consume avanta API

Actions57

Company - Group → Delete

AI-generated

Overview

This node operation deletes a specified company group in the Avanta system. It is useful for scenarios where you need to remove obsolete or unwanted company groups from your database or system. For example, if a company group is no longer relevant or was created by mistake, this operation allows you to delete it programmatically within an automation workflow.

Use Case Examples

  1. Deleting a company group by specifying its ID to clean up the company structure.
  2. Automating the removal of multiple company groups based on certain criteria by iterating over group IDs.

Properties

Name Meaning
Request Options Options to customize the API request behavior, including debug mode, SSL certificate validation, and request timeout settings.
Store Group Name or ID The ID of the store group to delete. Can be selected from a list or specified using an expression.
External IDs Comma-separated external IDs or JSON array/single ID expression to identify the groups to delete.

Output

JSON

  • success - Indicates whether the delete operation was successful.
  • message - Additional information or status message from the API response.

Dependencies

  • Avanta API key credential

Troubleshooting

  • Ensure the store group ID or external IDs are correctly specified; invalid or missing IDs will cause the delete operation to fail.
  • If SSL issues occur, enable the 'Ignore SSL Issues' option to bypass certificate validation, but be aware of security risks.
  • Timeout errors may occur if the server is slow to respond; increase the timeout value in request options if needed.

Links

Discussion