Perfex

Consume Perfex API

Overview

This node integrates with the Perfex API to manage customer data. Specifically, the "Update Customer" operation allows users to modify existing customer records by specifying the customer ID and the fields to update. This is useful in scenarios where customer information changes over time, such as updating contact details, company information, or custom fields.

Practical examples include:

  • Updating a customer's phone number or address after receiving new information.
  • Modifying assigned staff members responsible for a customer.
  • Adding or changing tags or custom fields to better categorize customers.

Properties

Name Meaning
Customer ID The unique identifier of the customer to update (required).
Company The company name associated with the customer (required).
VAT The VAT number of the customer.
Phone The customer's phone number.
Country The country where the customer is located.
City The city where the customer is located.
Zip The postal zip code of the customer's address.
State The state or region of the customer's address.
Address The street address of the customer.
Website The website URL of the customer.
Description Additional descriptive information about the customer.
Assigned The ID of the staff member assigned to this customer.
Tags Comma-separated list of tags to categorize or label the customer.
Custom Field Name The name of a custom field to add or update for the customer.
Custom Field Value The value corresponding to the custom field name.

Output

The node outputs JSON data representing the updated customer object returned from the Perfex API. This typically includes all customer fields after the update has been applied.

If multiple items are processed, each output item corresponds to one updated customer record.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Perfex API via an API key credential configured in n8n.
  • The base URL for the Perfex API must be set in the node credentials.
  • The node uses HTTP methods (PUT) to send update requests to the /api/customers/{customerId} endpoint.

Troubleshooting

  • Common issues:

    • Invalid or missing Customer ID will cause the API request to fail.
    • Providing invalid field values (e.g., malformed URLs or incorrect data types) may result in API errors.
    • Network connectivity problems or incorrect base URL configuration can prevent successful API calls.
  • Error messages:

    • Errors from the API will be surfaced as node execution errors, often including HTTP status codes and error messages from Perfex.
    • If the node is set to continue on failure, error details will be included in the output JSON under an error property.
  • Resolutions:

    • Verify that the Customer ID exists and is correct.
    • Ensure all required fields are provided and valid.
    • Check API credentials and base URL settings.
    • Review API documentation for field constraints and validation rules.

Links and References

Discussion