EspoCRM icon

EspoCRM

Interact with EspoCRM API

Overview

This node integrates with EspoCRM to perform operations on various resources, including Custom Entities. Specifically, the Update operation for a Custom Entity allows users to modify an existing record of a specified entity type by providing its ID and the data fields to update.

Common scenarios where this node is beneficial include:

  • Automating updates to CRM records such as Opportunities, Cases, or Products based on external triggers.
  • Synchronizing data between EspoCRM and other systems by programmatically updating records.
  • Bulk updating records in workflows without manual intervention.

For example, you could use this node to update the status of a Case entity when a support ticket is resolved or to change product details after receiving updated inventory information.

Properties

Name Meaning
Entity Type Name or ID The type of custom entity to interact with (e.g., Opportunity, Case, Product). Choose from a list loaded dynamically or specify an ID using an expression.
Record ID The unique identifier of the record to update.
Data JSON object containing the fields and values to update on the record.

Output

The output is a JSON array where each element corresponds to the result of an update operation on a record. Each element contains the updated record's data as returned by the EspoCRM API.

Example output structure (simplified):

[
  {
    "id": "record-id",
    "field1": "updated value",
    "field2": "updated value",
    ...
  }
]

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to an EspoCRM instance via an API key credential configured in n8n.
  • The node uses EspoCRM's REST API endpoints to perform CRUD operations.
  • The entityType options are dynamically loaded from the EspoCRM metadata service.
  • Proper permissions in EspoCRM are necessary to update records.

Troubleshooting

  • Error loading entity types or fields: This can occur if the API credentials are invalid or the EspoCRM instance is unreachable. Verify API credentials and network connectivity.
  • Record not found or invalid ID: Ensure the provided Record ID exists for the specified entity type.
  • Invalid data format: The Data property must be valid JSON matching the expected fields of the entity. Invalid or unsupported fields may cause errors.
  • Permission denied: The API user must have update permissions for the target entity.
  • Operation not supported error: Occurs if an unsupported operation is selected for the resource; ensure "Update" is chosen for Custom Entity.

To resolve these issues:

  • Double-check API credentials and endpoint URLs.
  • Validate input parameters and JSON syntax.
  • Confirm user permissions in EspoCRM.
  • Use expressions carefully to ensure correct dynamic values.

Links and References

Discussion