AtomicBI icon

AtomicBI

Interact with Atomic BI API

Actions16

Overview

The node interacts with the Atomic BI API to perform operations on various resources. For the Leads resource with the Update operation, it allows updating lead records by specifying filters and selecting which fields to update or retrieve. This is useful for automating lead management workflows, such as updating lead statuses, details, or other attributes based on dynamic criteria.

Typical use cases include:

  • Updating lead information in bulk based on specific filters.
  • Synchronizing lead data from external sources.
  • Automating lead qualification or status changes within a marketing or sales pipeline.

Properties

Name Meaning
Select List of fields to select from the Leads. Leave empty to select all fields. Options include Campaign Id, Space Id, Stage, Status, Details, Messages, Created At, Updated At, Company Name, Email, First Name, Last Name, etc.
Filter Filters to apply to select which Leads to update. Each filter includes: Field (selectable from predefined fields or custom), Operator (Equals, Like, ILike, Contains), and Value.
Offset Starting offset of Leads to return or update. Useful for pagination.
Limit Maximum number of Leads to return or update. Maximum allowed is 1000.
Order By Field by which to order the returned Leads. Same options as Select fields.
Order Direction Direction of ordering: Ascending or Descending.
Additional Select Advanced option to specify additional select fields for Leads using comma-separated values.

Output

The output consists of JSON objects representing the updated Lead records. Each object contains the fields selected via the "Select" property or all fields if none are specified. The structure corresponds directly to the Lead entity's attributes such as campaignId, email, firstName, lastName, companyName, status, stage, and others.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Atomic BI API.
  • Needs proper configuration of the Atomic BI API base URL and API key in n8n credentials.
  • Relies on the Atomic BI API being accessible and responsive.

Troubleshooting

  • Invalid operation error: If an unsupported operation or resource is specified, the node throws an error like Invalid operation: leads/UPDATE. Ensure the operation and resource names are correct and supported.
  • API authentication errors: If the API key is missing or invalid, requests will fail. Verify that the API key credential is correctly configured.
  • Filter syntax issues: Incorrect filter field names or operators may cause the API to reject the request. Use only supported fields and operators.
  • Limit and offset misuse: Setting limit too high or offset incorrectly might result in no data or partial updates. Keep limit under 1000 and verify offset logic.
  • Empty select fields: Leaving the select list empty selects all fields, which might be inefficient. Specify only needed fields to optimize performance.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion