Email SupportCall Us Go to Close

WhatsAppMessage


WhatsAppMessage activities represent messages in an external WhatsApp chat. These can be created by WhatsApp integrations, to facilitate viewing ongoing WhatsApp conversations within the CRM.

List or filter all WhatsAppMessage activities.

GET /activity/whatsapp_message/{?lead_id, user_id, external_whatsapp_message_id, date_created__gt, date_created__lt}

You can filter by external_whatsapp_message_id to find messages in Close to update or delete based on updates or deletions in WhatsApp.

Fetch a single WhatsAppMessage activity.

GET /activity/whatsapp_message/{id}/

Create a WhatsAppMessage activity.

POST /activity/whatsapp_message/{id}/{?send_to_inbox}

external_whatsapp_message_id must be the ID of the message inside WhatsApp. You can filter by this field to find messages in Close to update or delete based on updates or deletions in WhatsApp.

message_markdown must be the body of the message in the WhatsApp Markdown format. The message_html read-only field will return the HTML representation of this message.

To include an attachment, you must first upload the file to Close using the Files API. Then, add an object to the attachments array with the following fields: url, filename, and content_type. The url should be the URL provided in the download.url field of the response from the Files API. It must begin with https://app.close.com/go/file/.

integration_link (optional) is a URL string that can be provided by the integration partner creating the WhatsApp message. This can be used to link back to the message in the external system.

response_to (optional) is the Close activity ID of another WhatsApp message activity (not the WhatsApp native message ID) that this message is replying to. This field creates a thread relationship between messages, allowing you to track conversation flow and message replies within WhatsApp threads. The ID must be a valid WhatsApp message activity ID in Close (e.g., acti_...).

Only WhatsApp Markdown messages and file attachments are supported. No support is provided for Polls, Events, Locations, etc.

When creating a new WhatsApp message with the direction set to incoming, you can pass the query parameter send_to_inbox with the value of true to create a corresponding Inbox Notification for the message.

Update a WhatsAppMessage activity.

PUT /activity/whatsapp_message/{id}/

Delete a WhatsAppMessage activity.

DELETE /activity/whatsapp_message/{id}/