Send a WhatsApp message (standalone)

Sends a new WhatsApp message without requiring a conversation ID. This endpoint automatically finds or creates a conversation based on the phone number and WhatsApp configuration.

Configuration Selection:

• If whatsapp_config_id is provided, uses that specific configuration
• If customer_id is provided, uses the customer’s WhatsApp configuration
• If neither is provided, uses the first available configuration for the project

Conversation Management:

• Automatically finds existing active conversations for the phone number
• Creates new conversations if none exist
• Updates conversation activity timestamps
• Creates WhatsApp contacts as needed

Message Types: Supports all message types including text, template, media, interactive, location, reaction, and contacts.

Agent Integration: Respects agent execution states and handoff rules. Messages are blocked when an agent execution is active and not in handoff, failed, or stopped state.

POST /whatsapp_messages

cURL

text_message

curl --request POST \
  --url https://app.kapso.ai/api/v1/whatsapp_messages \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "message": {
    "phone_number": "[phone]",
    "content": "Hello, how can I help you today?",
    "message_type": "text"
  }
}
'

201

text_message

{
  "data": {
    "id": "msg-123abc",
    "phone_number": "[phone]",
    "message_type": "text",
    "content": "Hello, how can I help you today?",
    "direction": "outbound",
    "status": "sent",
    "whatsapp_message_id": "wamid.HBgLMTIzNDU2Nzg5MAUCAw==",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Authorizations

X-API-Key · string · header · required

API key required for all endpoints

Query Parameters

whatsapp_config_id · string<uuid>

ID of the specific WhatsApp configuration to use

customer_id · string<uuid>

ID of the customer whose WhatsApp configuration to use

phone_number · string

Phone number to send the message to (can also be provided in the message object)

Body

application/json

message · object · required

Show child attributes

Response

201

application/json

Message created and sent successfully

data · object

Show child attributes