Perfex

Consume Perfex API
Join our community

Actions14

Overview

This node integrates with the Perfex API to manage customer data. Specifically, the "Customer - Create" operation allows users to add new customers into their Perfex CRM system by providing relevant details such as company name, VAT number, contact information, and custom fields.

Common scenarios where this node is beneficial include:

  • Automating customer onboarding workflows by creating customer records from form submissions or other data sources.
  • Synchronizing customer data from external systems into Perfex CRM.
  • Bulk importing customer information programmatically.

For example, a business could use this node to automatically create a new customer in Perfex whenever a new order is placed on their e-commerce platform, ensuring that all customer details are captured without manual entry.

Properties

Name Meaning
Company The company name (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 of the customer's address.
Zip The zip code of the customer's address.
State The state or region of the customer's address.
Address The full street address of the customer.
Website The website URL of the customer's company.
Description Additional description or notes about the customer.
Assigned The ID of the staff member assigned to manage 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 additional information.
Custom Field Value The value corresponding to the custom field name provided.

Output

The node outputs JSON objects representing the newly created customer record as returned by the Perfex API. This typically includes all customer details stored in Perfex, such as the unique customer ID, company name, contact info, and any other fields set during creation.

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 instance must be set in the node credentials.
  • The node uses HTTP POST requests to the /api/customers endpoint of the Perfex API.

Troubleshooting

  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions to create customers.
  • Validation errors: Required fields like "Company" must be provided; missing these will cause the API to reject the request.
  • Network issues: Verify connectivity to the Perfex API base URL.
  • API errors: If the API returns errors, check the error message in the node output for details (e.g., invalid field formats).
  • Custom fields: Make sure custom field names and values conform to what the Perfex API expects.

Links and References

Discussion