ContactShip icon

ContactShip

Interact with ContactShip API for AI Phone Calls

Overview

This node integrates with the ContactShip API to manage contacts and related entities such as tags, call history, comments, boards, and agents. Specifically, the "Add Tag to Contact" operation allows users to assign a tag to an existing contact in their ContactShip organization. This is useful for categorizing or labeling contacts dynamically based on workflow conditions.

Practical scenarios include:

  • Automatically tagging contacts after certain interactions or events.
  • Organizing contacts by campaign, status, or interest using tags.
  • Enriching contact data for segmentation or reporting purposes.

Properties

Name Meaning
Tag ID The identifier of the tag to add to the contact. This is selected from available tags.

Note: The "Tag ID" property loads options dynamically from the user's tags in ContactShip.

Output

The node outputs JSON data representing the response from the ContactShip API after adding the tag to the contact. Typically, this will include confirmation details about the tag assignment or the updated contact information.

The output structure is:

{
  // API response data confirming the tag addition
}

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the ContactShip API.
  • The node depends on the ContactShip API being accessible at the configured base URL.
  • Dynamic option loading (e.g., tags) requires successful API calls to fetch current data.

Troubleshooting

  • Invalid Contact Identifier: If the contact ID provided does not exist or is malformed, the API will return an error. Verify the contact identifier is correct.
  • Invalid Tag ID: Selecting a tag that does not exist or is not accessible will cause failure. Ensure the tag list is up-to-date.
  • API Authentication Errors: Missing or invalid API credentials will prevent the node from working. Confirm the API key is correctly set in n8n credentials.
  • Network Issues: Connectivity problems to the ContactShip API endpoint can cause timeouts or errors.
  • Permission Issues: The API key must have permissions to modify contacts and tags.

Common error messages typically come directly from the ContactShip API and should be reviewed for specific causes.

Links and References

Discussion