SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Chats → Bulk Update Chats

AI-generated

Overview

This node enables bulk updates on WhatsApp chats associated with a specified WhatsApp number. It allows performing various actions such as resolving, pinning, muting, assigning agents, blocking, marking as read/unread, and managing labels on multiple chats simultaneously. This is particularly useful for customer support teams or sales departments managing large volumes of chat conversations, enabling efficient batch processing of chat statuses and assignments.

Practical examples:

  • Marking multiple chats as resolved after a support shift ends.
  • Assigning a group of chats to a specific agent or department.
  • Adding or removing labels to categorize chats in bulk.
  • Muting or unmuting several chats to control notifications.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number (device) on which the chats exist.
Action The operation to perform on the selected chats. Options include: Resolve, Unresolve, Pin, Unpin, Mute, Unmute, Assign, Unassign, Block, Unblock, Read, Unread, Labels.
Chat IDs/Phone Numbers List of chat identifiers or phone numbers to update. Can be multiple values like +447362053576 or 447362053576@c.us.
Labels to Add (Only when action is "Labels") Labels to add to the chats. Multiple values allowed.
Labels to Remove (Only when action is "Labels") Labels to remove from the chats. Multiple values allowed.
Agent ID (Only when action is "Assign") The agent to assign the chats to.
Department ID (Optional, only when action is "Assign") The department to assign the chats to.

Output

The node outputs an array of JSON objects representing the result of the bulk update operation for each input item. Each output JSON typically contains the response from the API indicating success or failure of the requested action on the specified chats.

If errors occur during execution and the node is configured to continue on failure, the output JSON will contain an error field with the error message.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the SparkBot WhatsApp API.
  • The node depends on the external SparkBot WhatsApp API service to perform chat operations.
  • Proper configuration of the WhatsApp number (device) and access to team agents and departments via the API is necessary for some actions.

Troubleshooting

  • Common issues:

    • Invalid or missing WhatsApp number/device ID can cause failures.
    • Providing incorrect chat IDs or phone numbers may result in no chats being updated.
    • Assigning chats to an invalid or unauthorized agent or department will fail.
    • Using label actions without specifying labels to add or remove may cause errors.

  • Error messages:

    • Errors returned from the API will be included in the output if "Continue On Fail" is enabled.
    • Authentication errors indicate problems with the API key credential.
    • Validation errors usually relate to malformed chat IDs or unsupported actions.

  • Resolutions:

    • Verify that the WhatsApp number/device ID is correct and active.
    • Ensure chat IDs or phone numbers are formatted properly.
    • Confirm that the agent and department IDs exist and are accessible.
    • Provide required label values when using label-related actions.

Links and References

Discussion