SuiteCRM icon

SuiteCRM

Generic node to operate with any SuiteCRM (SuiteCRM API) module.

Overview

This node provides a generic interface to interact with any SuiteCRM module via the SuiteCRM API. It supports common CRUD operations such as creating, reading, updating, and deleting records in SuiteCRM modules, as well as fetching relationships and listing multiple records with pagination support.

A typical use case is automating data synchronization between SuiteCRM and other systems, for example:

  • Creating new contacts or leads automatically from form submissions.
  • Updating account information based on external events.
  • Retrieving lists of opportunities or cases for reporting or further processing.
  • Deleting obsolete records programmatically.

The "Create" operation specifically allows users to add new records to any selected SuiteCRM module by providing the record data in JSON format.

Properties

Name Meaning
Module Select the SuiteCRM module where the record will be created (e.g., Contacts, Accounts).
Data (JSON) Provide the fields and their values for the new record as a JSON object.

Output

The output is an array containing one item per execution, each with a json property holding the response data from SuiteCRM:

  • For the "Create" operation, the json field contains the newly created record's data returned by the SuiteCRM API. This typically includes the record ID and all attributes stored.
  • No binary data is output by this node.

Example output structure (simplified):

{
  "json": {
    "id": "record-id",
    "type": "ModuleName",
    "attributes": {
      "field1": "value1",
      "field2": "value2"
      // ... other fields as saved
    }
  }
}

Dependencies

  • Requires valid credentials for authenticating with the SuiteCRM API (an API key or OAuth token).
  • The node expects the SuiteCRM instance URL and access token to be provided via these credentials.
  • Uses HTTP requests to communicate with SuiteCRM's REST API endpoints.

Troubleshooting

  • Authentication errors: Ensure that the API credentials are correctly configured and have sufficient permissions.
  • Invalid module name: The "Module" property must match an existing SuiteCRM module; otherwise, the API will return an error.
  • Malformed JSON in Data: The "Data (JSON)" input must be valid JSON representing the fields and values; invalid JSON will cause parsing errors.
  • API endpoint errors: Network issues or incorrect SuiteCRM URLs can cause request failures.
  • Missing required fields: If mandatory fields for the module are not included in the data, the API may reject the creation request.

To resolve these issues:

  • Double-check credentials and permissions.
  • Use the node's option to load available modules dynamically.
  • Validate JSON syntax before running.
  • Confirm the SuiteCRM base URL and API availability.
  • Include all required fields for the target module.

Links and References

Discussion