Commanders Act icon

Commanders Act

Use the Commanders Act API
Join our community

Actions108

Overview

This node integrates with the Commanders Act API, specifically supporting various resources and operations related to data management and privacy compliance. The "Cookie Scanner" resource with the "Destroy Custom Field" operation allows users to delete a custom field previously defined in the cookie scanner settings of the Commanders Act platform.

Use cases include managing cookie consent configurations by removing obsolete or incorrect custom fields from the cookie scanner setup. This is beneficial for maintaining accurate cookie categorization and ensuring compliance with privacy regulations.

Example scenario: A user wants to clean up their cookie scanner configuration by deleting a custom field that is no longer relevant or was created by mistake.

Properties

Name Meaning
Custom Field ID The unique identifier of the custom field to be destroyed (deleted).
Query Parameters Optional additional parameters to customize the API request. Includes options like: End, Fields[template], Filter (with sub-options such as begin_date, end_date, search, segment_id, device, location, etc.), Granularity, Include, Page, Sort, Source, Start, Token (API token, password type).

The "Query Parameters" collection allows fine-tuning the API call with filters, pagination, sorting, and other query options supported by the Commanders Act API.

Output

The output is a JSON array where each element corresponds to the response from the API for each input item processed.

  • For the "Destroy Custom Field" operation, the output typically contains the API's response confirming the deletion or an empty/no content status.
  • If the API returns a string response, the node attempts to parse it as JSON; if parsing fails, it outputs the raw text.
  • If no content is returned (HTTP 204), the node outputs a JSON object indicating "204 No Content".
  • The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Commanders Act API.
  • The node uses the base URL https://api.commander1.com/v2.
  • Proper configuration of the API credentials in n8n is necessary before using this node.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node throws an error "Missing Commanders Act API Credentials". Ensure the API key is configured correctly.
  • Required Parameter Missing: For the "Destroy Custom Field" operation, if the "Custom Field ID" is not provided, the node throws an error stating "Custom Field ID is required". Provide the correct ID.
  • API Errors: Any errors returned by the Commanders Act API will be wrapped and thrown as node errors with messages like "Error calling Commanders Act API: [error message]". Check the API response and ensure the request parameters are valid.
  • Parsing Response Issues: If the API returns a non-JSON string, the node outputs the raw text. Unexpected formats may require checking the API documentation or contacting support.

Links and References

This summary focuses on the "Cookie Scanner" resource and the "Destroy Custom Field" operation as requested.

Discussion