ContactShipInstall

Overview

This node integrates with the ContactShip API to manage contacts and related entities such as calls, agents, tags, and boards. Specifically for the Contact - Delete operation, it allows users to delete a contact by specifying an identifier (ID, phone number, or email). This is useful in scenarios where you want to remove outdated or incorrect contact information from your system.

Practical examples:

• Automatically deleting contacts who have unsubscribed or requested removal.
• Cleaning up test or duplicate contacts from your database.
• Integrating with workflows that archive or purge contacts after certain events.

Properties

Output

The output JSON contains a simple success confirmation object:

{
  "success": true
}

This indicates that the contact was successfully deleted. If deletion fails, an error will be thrown or returned depending on the node's error handling settings.

Dependencies

• Requires an API key credential for authenticating with the ContactShip API.
• Needs the base URL of the ContactShip API endpoint configured in credentials.
• The node uses HTTP DELETE requests to the /v1/contacts/{contactIdentifier} endpoint.

Troubleshooting

• Invalid Contact Identifier: If the provided identifier does not match any existing contact, the API may return an error indicating the contact was not found. Verify the identifier is correct and exists.
• Authentication Errors: Ensure the API key credential is valid and has permissions to delete contacts.
• Network Issues: Connectivity problems can cause request failures; check network access to the ContactShip API.
• Permission Denied: The API user might lack rights to delete contacts; verify API user roles and permissions.

Common error messages:

• "Invalid phone number format" — occurs if the identifier is expected to be a phone number but is malformed.
• "Contact not found" — no contact matches the given identifier.
• "Unauthorized" or "Forbidden" — authentication or permission issues.

Resolving these typically involves verifying input values, credentials, and API permissions.

Links and References

• ContactShip API Documentation (hypothetical link, replace with actual if available)
• n8n documentation on Creating Custom Nodes
• E.164 phone number format reference: https://en.wikipedia.org/wiki/E.164