ContactShip

Interact with ContactShip API for AI Phone Calls

Actions20

Overview

The node integrates with the ContactShip API to manage contacts within an organization. Specifically, the Update Contact operation allows users to modify existing contact details such as full name, email, description, predefined properties, and custom additional data.

This operation is useful in scenarios where contact information needs to be kept current, for example:

Updating a customer's email or phone number after they provide new details.
Adding notes or descriptions about a contact based on recent interactions.
Modifying organizational properties or adding custom metadata to contacts for better segmentation or personalization.

Practical example: A sales automation workflow could use this node to update contact records automatically when a lead submits a form with updated information, ensuring the CRM always has the latest data.

Properties

Name	Meaning
Contact Identifier	The unique identifier of the contact to update. Can be an ID, phone number, or email.
Update Fields	Collection of fields to update on the contact:
- Full Name	New full name of the contact.
- Email	New email address of the contact.
- Description	New description or notes about the contact.
- Contact Properties	Predefined organizational properties to update. Each property includes a selected property and its new value.
- Custom Properties	Custom additional data to update, supporting types like Text, URL, Location, Number, Calendar, Select. Each entry includes type, field name, and value.

Output

The output JSON contains the updated contact data returned from the ContactShip API after the PATCH request. This typically includes the contact's updated fields and metadata as confirmed by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "contact-id",
  "full_name": "Updated Name",
  "email": "updated.email@example.com",
  "description": "Updated description",
  "additional_data": [
    {
      "type": "text",
      "field": "customField1",
      "value": "Custom Value"
    }
  ],
  ...
}

Dependencies

Requires an active connection to the ContactShip API via an API key credential.
The node uses the ContactShip API base URL and API key configured in the credentials.
The API expects phone numbers in E.164 format when relevant.
The node depends on internal utility functions for making HTTP requests and validating phone numbers.

Troubleshooting

Invalid phone number format error: If updating phone-related fields, ensure phone numbers are in E.164 format (e.g., +12124567890). Incorrect formats will cause validation errors.
Parsing errors for properties: When specifying predefined contact properties, the property field must be valid JSON representing the property metadata. Malformed JSON will cause parsing errors logged internally.
API errors: Any issues with authentication, permissions, or invalid identifiers will result in API errors. Verify that the API key is valid and the contact identifier exists.
Partial updates: Only fields provided in the "Update Fields" collection are sent; missing fields remain unchanged.

Links and References

ContactShip API Documentation (hypothetical link)
E.164 Phone Number Format
n8n documentation on Creating Custom Nodes

ContactShipInstall