Creatio icon

Creatio

Consume Creatio API

Overview

This node integrates with the Creatio API, allowing users to perform various operations on Creatio data entities via OData endpoints. Specifically for the PATCH operation, it updates an existing record in a specified Creatio entity (table). Users provide the entity name, the ID of the record to update, and a JSON body containing the fields and values to modify.

Common scenarios where this node is beneficial include:

  • Updating customer or contact information in Creatio CRM.
  • Modifying status or details of business process records.
  • Automating data synchronization by patching records based on external triggers.

For example, you might use this node to update a lead's status after a phone call or to correct a typo in a contact's email address.

Properties

Name Meaning
Subpath Name or ID The Creatio entity (table) to operate on. Choose from a dynamically loaded list of available OData entities or specify an expression to define it.
ID The unique identifier of the record within the selected entity that you want to update.
Body A JSON object representing the fields and their new values to update in the record. This must be valid JSON and contain the properties to patch.
Append Request Whether to append the original request parameters to the output along with the response. If enabled, the output will include both the request details and the API response.
Specify Input Schema Optionally enforce input schema validation for the function input. When enabled, the input must conform to the defined JSON schema, either generated from an example or manually specified.
Schema Type Defines how the input schema is specified: either generated automatically from a JSON example or manually defined using JSON Schema format.
JSON Example An example JSON object used to generate the input schema automatically when "Generate From JSON Example" is selected.
Input Schema A manually defined JSON Schema describing the expected input structure when "Define using JSON Schema" is selected.

Output

The node outputs a JSON array where each element corresponds to one execution item. For the PATCH operation, the output contains the response from the Creatio API after updating the record. This typically includes the updated record data or confirmation of the update.

If the "Append Request" option is enabled, each output element will be an object containing:

  • The original request parameters (operation, subpath, id, body).
  • The API response under the response property.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Creatio API.
  • The node performs authentication by sending credentials to the Creatio login service and managing cookies for session and CSRF protection.
  • The Creatio instance URL, username, and password must be configured in the credentials.
  • The node uses HTTP requests with appropriate headers including cookies and CSRF tokens to interact with the Creatio OData API.

Troubleshooting

  • Authentication failures: Errors during login usually indicate incorrect credentials or connectivity issues. Verify the API credentials and network access to the Creatio instance.
  • Invalid entity or record ID: If the specified entity (subpath) or record ID does not exist, the API may return errors or empty responses. Ensure the entity name and ID are correct.
  • Malformed JSON body: The PATCH body must be valid JSON matching the expected schema of the entity. Invalid JSON or unsupported fields can cause API errors.
  • HTTP 401 Unauthorized: Indicates authentication failure or expired session. Recheck credentials and ensure the node can authenticate successfully.
  • Empty response on delete or patch: Sometimes the API returns an empty string on success; the node converts this to { deleted: true } for DELETE but PATCH expects a JSON response. Lack of response may require checking API logs.
  • Schema validation errors: If input schema enforcement is enabled, inputs not conforming to the schema will cause validation errors before the request is sent.

Links and References

Discussion