AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node performs a patch update on a company mapping within an integration system. It allows users to modify specific fields of a company mapping by sending partial data updates rather than replacing the entire resource. This is useful in scenarios where only certain attributes of a company mapping need to be changed, such as toggling notification settings or updating configuration flags without affecting other data.

Practical examples include:

  • Enabling or disabling notifications for a company.
  • Updating consent or configuration flags related to the integration.
  • Modifying integration rules stored as JSON arrays.

Properties

Name Meaning
X USER ID The user identifier required for authentication or tracking purposes in the request header.
Additional Body Fields Optional fields to include in the request body:
- Data: JSON object containing flags and settings such as no_notification, enable_notification, consent_enabled, configuration, and integration_rules (a JSON array as string).
- Id: Numeric identifier of the company mapping to update.

Output

The node outputs JSON data representing the response from the patch update operation. This typically includes the updated state of the company mapping after applying the changes. The exact structure depends on the API's response but generally reflects the current values of the updated fields.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating requests to the integration service.
  • The base URL for the API must be configured in the node credentials.
  • The node sends HTTP PATCH requests with JSON payloads and expects JSON responses.

Troubleshooting

  • Missing or invalid X USER ID: The node requires a valid user ID header; ensure this is provided and correctly formatted.
  • Invalid JSON in Data field: The data property expects a valid JSON string; malformed JSON will cause errors.
  • Incorrect Id value: The id must correspond to an existing company mapping; using an invalid or non-existent ID may result in not found errors.
  • API connectivity issues: Verify that the base URL and API credentials are correct and that the API service is reachable.
  • Permission errors: Ensure the API key has sufficient permissions to perform patch updates on company mappings.

Links and References

  • No direct external links provided in the source code.
  • For more details, consult the API documentation of the integration service being used.

Discussion