Actions113
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
Messages API → Update A Message
AI-generatedOverview
The "Update A Message" operation in the Messages API resource allows users to modify an existing message within a conversation in a specified inbox. This node is useful when you need to correct, append, or otherwise change the content or metadata of a message that has already been sent or received in a chat system.
Common scenarios include:
- Correcting typos or errors in a previously sent message.
- Adding additional information or context to a message after it was initially sent.
- Updating message status or custom fields as part of workflow automation.
For example, if a customer support agent realizes a message contains incorrect information, they can use this node to update the message without sending a new one, maintaining conversation clarity.
Properties
| Name | Meaning |
|---|---|
| Inbox Identifier | The unique identifier for the inbox channel where the conversation resides. |
| Contact Identifier | The source ID of the contact associated with the message, obtained when the contact was created. |
| Conversation Id | The numeric ID representing the specific conversation containing the message. |
| Message Id | The numeric ID of the message to be updated. |
| Submitted Values | A JSON object containing the fields and values to update on the message. |
Output
The node outputs JSON data representing the updated message object returned by the API. This typically includes the message's current state after the update, such as its content, timestamps, sender information, and any other relevant metadata.
If the API supports binary data (e.g., attachments), the node would handle it accordingly, but based on the provided code and properties, the focus is on JSON message updates.
Dependencies
- Requires an active connection to the ChatWoot API service.
- Needs an API authentication token configured in the node credentials to authorize requests.
- The base URL for the ChatWoot instance must be set in the credentials configuration.
Troubleshooting
- Invalid Identifiers: Errors may occur if the inbox, contact, conversation, or message IDs are incorrect or do not exist. Verify these IDs before running the node.
- Authentication Failures: Ensure the API key or token is valid and has sufficient permissions to update messages.
- Malformed JSON in Submitted Values: The
submitted_valuesproperty expects valid JSON. Invalid JSON syntax will cause parsing errors. Use proper JSON formatting. - API Rate Limits: Frequent updates might hit rate limits imposed by the ChatWoot API. Implement retry logic or reduce request frequency if needed.
Links and References
- ChatWoot API Documentation – Official API docs for detailed endpoint info.
- JSON Syntax Guide – Reference for correct JSON formatting.