avanta icon

avanta

Consume avanta API

Actions57

Company - Role → Delete

AI-generated

Overview

This node operation deletes one or more company roles identified by their external IDs. It is useful for managing company roles by removing outdated or unnecessary roles from the system. For example, if a company role is no longer needed, this operation can be used to delete it by specifying its external ID(s).

Use Case Examples

  1. Deleting a single company role by providing its external ID.
  2. Deleting multiple company roles by providing a comma-separated list or JSON array of external IDs.

Properties

Name Meaning
Request Options Options to customize the API request behavior, including debug mode, SSL certificate validation, and request timeout settings.
External IDs Comma-separated or JSON array of external IDs of the company roles to be deleted.

Output

JSON

  • success - Indicates whether the delete operation was successful.
  • deletedIds - List of external IDs that were deleted.
  • debugInfo - Optional debug information about the API request if debug mode is enabled.

Dependencies

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

Troubleshooting

  • Ensure the external IDs provided are valid and exist in the system; invalid IDs may cause the delete operation to fail.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of the security risks.
  • If the request times out, increase the timeout value in the request options.
  • Enable debug mode to get detailed API request information to help diagnose issues.

Discussion