Perfex

Consume Perfex API
Join our community

Actions14

Overview

This node integrates with the Perfex API to manage CRM entities such as Leads, Customers, and Contacts. Specifically for the Lead - Delete operation, it allows users to delete a lead from their Perfex CRM system by specifying the lead's unique ID. This is useful in scenarios where leads are no longer relevant or were created in error and need to be removed to keep the CRM data clean.

Practical example:

  • Automatically deleting leads that have been marked as invalid or duplicates after a validation process.
  • Removing leads that have unsubscribed or requested removal via an automated workflow.

Properties

Name Meaning
Lead ID The ID of the lead to be deleted

The "Lead ID" property is required and must be provided as a string representing the unique identifier of the lead in the Perfex system.

Output

The output JSON contains the response from the Perfex API after attempting to delete the specified lead. Typically, this will be an object indicating success or failure of the deletion request. The exact structure depends on the API but usually includes status information or confirmation of deletion.

No binary data output is produced by this operation.

Example output JSON might look like:

{
  "success": true,
  "message": "Lead deleted successfully"
}

or an error message if deletion failed.

Dependencies

  • Requires an active connection to the Perfex API.
  • Needs an API authentication token configured in the node credentials (referred generically as "an API key credential").
  • The base URL for the Perfex API must be set in the credentials configuration.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Lead ID will result in an error from the API.
    • Network connectivity problems can cause request failures.
    • Insufficient permissions or invalid API credentials will prevent successful deletion.

  • Error messages:

    • Errors returned by the API typically include HTTP status codes and messages such as "Lead not found" or "Unauthorized".
    • If the node throws an error about missing parameters, ensure the Lead ID is correctly set and not empty.
    • To resolve errors, verify the Lead ID exists, check API credentials, and confirm network access to the Perfex API endpoint.

Links and References

Discussion