ContactShipInstall

Overview

This node integrates with the ContactShip API to manage contacts and their association with boards and stages within an organization. Specifically, the "Add Contact to Board" operation allows users to add an existing contact as a card to a specified board stage, optionally defining the position of the card within that stage.

Common scenarios for this node include:

• Organizing contacts visually on project or sales boards.
• Automating workflow steps by moving contacts through different stages.
• Managing contact pipelines in CRM-like boards.

For example, you might use this node to automatically add a new lead (contact) to the "New Leads" stage of your sales pipeline board, placing them at the top of the list.

Properties

Output

The node outputs JSON data representing the response from the ContactShip API after adding the contact to the board. This typically includes details about the created card such as its ID, associated contact, stage, order, and other metadata.

No binary data output is involved in this operation.

Example output structure (simplified):

{
  "id": "card_id",
  "entity_id": "contact_id",
  "stage_id": "stage_id",
  "order": "0",
  "entity_type": "CONTACT",
  ...
}

Dependencies

• Requires an API key credential for authenticating with the ContactShip API.
• The node depends on the ContactShip API endpoints for boards, stages, and cards.
• Dynamic options for boards and stages are loaded via API calls.
• Proper configuration of the API base URL and authentication token is necessary.

Troubleshooting

• Invalid Contact ID: If the contact ID does not exist or is incorrect, the API will likely return an error. Verify the contact ID before using it.
• Board or Stage Not Found: Selecting a board or stage that does not exist or to which the user has no access will cause failures. Ensure the board and stage IDs are valid and accessible.
• Order Value Issues: Providing a non-numeric or negative order value may cause unexpected behavior. Use "0" or positive integers.
• API Authentication Errors: Missing or invalid API credentials will prevent the node from working. Confirm that the API key is correctly set up in n8n credentials.
• Network or API Downtime: Temporary network issues or ContactShip API downtime can cause request failures. Retry later or check API status.

Error messages returned by the node generally reflect the underlying API errors and should be reviewed accordingly.

Links and References

• ContactShip API Documentation (hypothetical link, replace with actual if available)
• n8n Documentation - Creating Custom Nodes
• E.164 Phone Number Format (relevant for phone number validation in other operations)

If you need summaries for other operations or resources, feel free to ask!