Create a WhatsAppMessage activity | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/activity/whatsapp_message/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "activity_at": "2016-10-03T16:06:11.167000+00:00",
  "contact_id": "cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk",
  "direction": "outgoing",
  "external_whatsapp_message_id": "1234567890",
  "lead_id": "lead_iuSXNk1x3446ggPVwQS7ynmp8pGRIDieRYiCnuo4yFb",
  "local_phone": "16503334444",
  "message_markdown": "test",
  "remote_phone": "18183004000",
  "integration_link": "https://example.com/messages/1234567890",
  "response_to_id": "acti_asjiweURMfsLgKuYGqbQ4Qp7L5a16pQOcDfTgotqDak",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH"
}'

{
  "_type": "WhatsAppMessage",
  "activity_at": "2016-10-03T16:06:11.167000+00:00",
  "contact_id": "cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk",
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2016-10-03T16:06:11.167000+00:00",
  "date_updated": "2016-10-03T16:06:11.167000+00:00",
  "direction": "outgoing",
  "external_whatsapp_message_id": "1234567890",
  "id": "acti_12358hIUhaklslYoYSbtozZuUTyB2zO2nhm7iVSpZpp",
  "integration_link": "https://example.com/messages/1234567890",
  "integration_name": "API",
  "lead_id": "lead_iuSXNk1x3446ggPVwQS7ynmp8pGRIDieRYiCnuo4yFb",
  "local_phone": "+16503334444",
  "local_phone_formatted": "+1 650-333-444",
  "message_html": "<p>test</p>",
  "message_markdown": "test",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "remote_phone": "+18183004000",
  "remote_phone_formatted": "+1 818-300-4000",
  "response_to_id": "acti_asjiweURMfsLgKuYGqbQ4Qp7L5a16pQOcDfTgotqDak",
  "source": "api",
  "text": "test",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "users": [],
  "attachments": [],
  "created_by_name": "Tobias Fuenke",
  "updated_by_name": "Tobias Fuenke",
  "user_name": "Tobias Fuenke"
}

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_id (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.

Important: The total size of all attachments for a single WhatsApp message activity cannot exceed 25MB.

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.

`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](/resources/files/). 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](/resources/files/). 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_id` (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. **Important**: The total size of all attachments for a single WhatsApp message activity cannot exceed 25MB. 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.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

send_to_inboxbooleanOptional

Request

This endpoint expects an object.

activity_atdatetimeRequired

contact_idstringRequired

directionenumRequired

This is the former EmailDirection. Any activity that has a concept of direction (in or out) should be using this enum. For historical reasons, this is different from PhoneActivityDirection but at some point PhoneActivityDirection should be deprecated and replaced with CommunicationDirection.

Allowed values:

external_whatsapp_message_idstringRequired

lead_idstringRequired

local_phonestringRequired

message_markdownstringRequired

remote_phonestringRequired

attachmentslist of objectsOptional

integration_linkstring or nullOptionalformat: "uri"1-2083 characters

response_to_idstring or nullOptional

user_idstring or nullOptional

Response

Successful response

_typestring

activity_atdatetime or null

contact_idstring or null

created_bystring or null

date_createddatetime

date_updateddatetime

directionenum

Allowed values:

external_whatsapp_message_idstring

idstring

integration_linkstring or null

integration_namestring or null

lead_idstring or null

local_phonestring

local_phone_formattedstring

message_htmlstring

message_markdownstring

organization_idstring

remote_phonestring

remote_phone_formattedstring

response_to_idstring or null

sourceenum

textstring

updated_bystring or null

user_idstring or null

userslist of strings

attachmentslist of objects

created_by_namestring or null

sequence_idstring or null

sequence_namestring or null

sequence_subscription_idstring or null

updated_by_namestring or null

user_namestring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

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.

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.

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

Important: The total size of all attachments for a single WhatsApp message activity cannot exceed 25MB.