QContact icon

QContact

Consume QContact API (v.0.1.3)

Actions7

Overview

This node allows you to edit an existing Entity in the QContact system via its API. It is designed for scenarios where you need to update records (entities) with new or modified data, either by specifying fields individually or by providing a JSON object. This is useful in automated workflows that require keeping entity information up-to-date, such as synchronizing contact details, updating customer profiles, or modifying custom objects in your QContact environment.

Practical examples:

  • Updating a customer's email address and phone number after receiving new information.
  • Modifying status fields on support tickets or leads.
  • Bulk-updating attributes of entities based on external triggers or data sources.

Properties

Name Type Meaning
Entity options The type of entity you want to edit (e.g., Contact, Company).
ID number The unique identifier of the entity record to be edited.
As JSON boolean If enabled, allows you to provide all parameters as a single JSON object.
JSON json The JSON object containing the fields and values to update (used if "As JSON" is true).
Fields fixedCollection A collection of field name/value pairs to update (used if "As JSON" is false).

Output

The node outputs a json object representing the updated entity. The structure typically includes:

  • The entity's ID
  • Updated fields and their new values
  • Any metadata returned by the QContact API about the update operation

Note: If the API returns binary data, it will be included as a binary property, but for this operation, output is expected to be JSON.

Dependencies

  • QContact API: Requires access to the QContact API endpoint.
  • API Credentials: You must configure valid QContact API credentials in n8n under the name qContactApi.
  • n8n Configuration: No special environment variables are required beyond standard credential setup.

Troubleshooting

  • Invalid Credentials: If your API key or credentials are incorrect, the node will fail authentication. Double-check your credentials in n8n.
  • Entity Not Found: If the provided ID does not correspond to an existing entity, you may receive an error like "Entity not found" or a 404 response from the API.
  • Malformed JSON: If using the "As JSON" option, ensure your JSON is properly formatted. Malformed JSON will result in parsing errors.
  • Missing Required Fields: Some entities may require certain fields to be present; omitting them could cause validation errors from the API.

Links and References

Discussion