Perfex

Consume Perfex API

Overview

This node integrates with the Perfex API to manage contacts within a CRM system. Specifically, the Update Contact operation allows users to modify existing contact details by specifying the contact's unique ID and providing updated information such as name, email, phone number, and status.

Common scenarios for this node include:

  • Keeping contact information up-to-date after changes in customer details.
  • Correcting errors or typos in contact records.
  • Activating or deactivating contacts based on their current status.
  • Managing primary contacts for customers.

For example, you might use this node to update a contact’s phone number and mark them as the primary contact for a customer after receiving new information.

Properties

Name Meaning
Contact ID The unique identifier of the contact to update (required).
Customer ID The ID of the customer this contact belongs to (required).
First Name The first name of the contact (required).
Last Name The last name of the contact (required).
Email The email address of the contact (required).
Phone The phone number of the contact (optional).
Title The job title or position of the contact (optional).
Direction The text direction for the contact's information; options are "ltr" (left-to-right) or "rtl" (right-to-left). Default is "ltr".
Password The password for the contact account (optional, input is masked).
Is Primary Boolean flag indicating whether this contact is the primary contact for the customer.
Active Boolean flag indicating whether the contact is active. Defaults to true.

Output

The node outputs JSON data representing the updated contact object returned from the Perfex API. This typically includes all contact fields such as IDs, names, email, phone, status flags, and any other metadata provided by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "123",
  "customer_id": "456",
  "firstname": "John",
  "lastname": "Doe",
  "email": "john.doe@example.com",
  "phonenumber": "+1234567890",
  "title": "Manager",
  "direction": "ltr",
  "is_primary": true,
  "active": true
}

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests against the Perfex API.
  • The base URL for the Perfex API must be set in the node credentials.
  • The node uses HTTP methods (PUT) to update contact data via the /api/contacts/{contactId} endpoint.

Troubleshooting

  • Invalid Contact ID: If the specified Contact ID does not exist, the API will likely return a 404 error. Verify the Contact ID is correct.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to update contacts.
  • Missing Required Fields: The operation requires certain fields like Contact ID, Customer ID, First Name, Last Name, and Email. Omitting these may cause validation errors.
  • API Rate Limits: If many updates are performed rapidly, the API might throttle requests. Implement retry logic or reduce request frequency.
  • Network Issues: Connectivity problems can cause request failures. Check network access to the Perfex API endpoint.

Links and References

Discussion