SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API
Join our community

Actions148

Overview

The "Update Contact" operation in the Chat Contacts resource allows users to modify existing WhatsApp contact details within their SparkBot WhatsApp API integration. This node is useful for keeping contact information up-to-date, such as changing names, phone numbers, company details, or other metadata associated with a contact.

Practical scenarios include:

  • Updating a customer's contact info after they provide new details.
  • Correcting errors in stored contact data.
  • Adding or modifying metadata tags for better segmentation or CRM integration.
  • Removing outdated or incorrect fields from a contact record.

This operation helps maintain accurate and enriched contact records, which can improve communication personalization and CRM synchronization.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number (device) through which the contact is managed.
Contact ID The unique identifier of the contact to update (e.g., 447362053576@c.us).
Contact Fields A collection of fields to update on the contact, including:
- Name (first name, max 30 chars)
- Surname (last name, max 50 chars)
- Title (max 15 chars)
- Contact Type (Personal, Business)
- Gender (Male, Female, Other)
- Alternative Phone (E.164 format)
- Email
- Description (max 100 chars)
- Languages (up to 3 language codes)
- Company Name, Code, Tax ID, Role, Website, Email, Phone, Country
- Currency code
- Address, City, Postal Code, Country
- Notes (internal, max 3000 chars)
- Birthday
- Notifications (On, Mute, Ignore)
- Timezone
- CRM source and reference
- Sync Across All Numbers (boolean)
Metadata Key-value pairs of metadata to add or update on the contact. Keys must be alphanumeric or underscores; values up to 300 characters. Multiple metadata entries can be added.
Fields to Remove List of contact fields to remove from the contact record. Options include most contact fields like Name, Surname, Email, Company details, Address, Notes, Gender, Birthday, Description, Languages, Sync, etc.

Output

The node outputs JSON data representing the updated contact object returned by the SparkBot API. This typically includes all current contact details after the update, reflecting any changes made or fields removed.

If the operation supports binary data (not indicated here), it would represent attachments or media related to the contact, but this operation focuses on JSON contact data only.

Dependencies

  • Requires an API key credential for authenticating with the SparkBot WhatsApp API.
  • The node depends on the SparkBot API endpoints for chat contacts management.
  • Proper configuration of the WhatsApp number (device) in the account is necessary.
  • The node uses internal methods to load available devices and validate input parameters.

Troubleshooting

  • Common issues:

    • Invalid or missing Contact ID will cause the update to fail.
    • Providing invalid field formats (e.g., wrong date format for birthday, invalid phone number format) may result in API errors.
    • Attempting to remove fields that do not exist might be ignored or cause warnings.
    • Insufficient permissions or invalid API key will prevent successful updates.

  • Error messages:

    • "Contact not found": Verify the Contact ID is correct and exists under the specified WhatsApp number.
    • "Invalid parameter": Check the format and allowed values of each field being updated.
    • "Authentication failed": Ensure the API key credential is valid and has required access.

  • Resolution tips:

    • Double-check all input property values before execution.
    • Use the "Fields to Remove" carefully to avoid deleting important data unintentionally.
    • Enable "Continue On Fail" in the node settings to handle partial failures gracefully.

Links and References

Discussion