SuiteCRM icon

SuiteCRM

Consume SuiteCRM API (v.1.0.15)
Join our community

Actions8

Overview

This node integrates with the SuiteCRM API, allowing users to perform various operations on SuiteCRM modules, including a custom operation. It supports standard CRUD operations and a flexible custom operation where users can specify HTTP methods, query parameters, and request bodies either as JSON or key-value pairs. This node is useful for automating interactions with SuiteCRM data, such as retrieving records, creating or updating entries, linking related records, or executing custom API calls for advanced use cases.

Use Case Examples

  1. Retrieve a list of contacts with specific filters.
  2. Create a new lead in SuiteCRM with custom attributes.
  3. Update an existing account record by ID.
  4. Perform a custom POST request to a SuiteCRM custom module endpoint with JSON body and query parameters.

Properties

Name Meaning
Module The SuiteCRM module on which to perform the operation. If 'Custom' is selected, a custom module path can be specified.
Full Custom Module Path Boolean flag to indicate if the full path to the custom module is provided. If false, '/custom' is prepended to the module path.
Custom Module Path The path to the custom module to perform the operation on, used when 'Custom' module is selected.
Description Optional description of the node instance.
Method HTTP method to use for the custom operation, e.g., POST, GET, PATCH.
JSON Query Params Flag to specify if query parameters should be provided as a JSON object.
Query Params JSON Query parameters as a JSON object, used if 'JSON Query Params' is true.
Query Params Query parameters as key-value pairs, used if 'JSON Query Params' is false.
JSON Body Flag to specify if the request body should be provided as a JSON object.
Body JSON Request body as a JSON object, used if 'JSON Body' is true.
Body Request body as key-value pairs, used if 'JSON Body' is false.

Output

JSON

  • data - The data returned from the SuiteCRM API call, which can be a single object or an array of objects representing SuiteCRM records or responses.

Dependencies

  • SuiteCRM API

Troubleshooting

  • Common issues include incorrect module names or paths, especially when using custom modules. Ensure the module path is correct and the 'Full Custom Module Path' flag is set appropriately.
  • Errors may occur if required parameters like 'beanId' or 'id' for specific operations are missing or invalid.
  • API authentication errors can happen if the SuiteCRM API credentials are not set up correctly or have expired.
  • Malformed JSON in 'Query Params JSON' or 'Body JSON' fields can cause request failures; ensure valid JSON syntax.

Links

Discussion