Perfex

Consume Perfex API
Join our community

Actions14

Overview

This node integrates with the Perfex API to manage contacts within the system. Specifically, the "Create Contact" operation allows users to add a new contact associated with a customer in Perfex. This is useful for automating CRM workflows where new contacts need to be programmatically added based on external triggers or data sources.

Practical examples include:

  • Automatically adding a new contact when a lead converts into a customer.
  • Syncing contacts from other platforms or databases into Perfex.
  • Creating contacts as part of onboarding processes or marketing campaigns.

Properties

Name Meaning
Customer ID The unique identifier 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 A 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 objects representing the newly created contact(s) as returned by the Perfex API. Each output item contains the full response data from the API about the created contact, including all fields stored in Perfex.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Perfex API.
  • The base URL for the Perfex instance must be configured in the node credentials.
  • The node uses HTTP POST requests to the /api/contacts endpoint of the Perfex API.

Troubleshooting

  • Common issues:

    • Missing required fields such as Customer ID, First Name, Last Name, or Email will cause the API request to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Invalid Customer ID (e.g., referencing a non-existent customer) will cause the API to reject the creation request.

  • Error messages:

    • Authentication errors typically indicate invalid API keys or misconfigured credentials.
    • Validation errors from the API will specify which required fields are missing or invalid.
    • Network or connectivity issues may cause timeouts or unreachable host errors.

  • Resolutions:

    • Ensure all required properties are provided and valid.
    • Verify that the API key and base URL are correctly set up in the node credentials.
    • Confirm the referenced Customer ID exists in the Perfex system.
    • Check network connectivity to the Perfex API endpoint.

Links and References

Discussion