Submit WhatsApp number.

Accepts one lead and queues it for processing.

The listing reference_id must match a chat intro on this WhatsApp number. The enquirer must carry a name and at least one of enquirer_phone_number or enquirer_email_address. A phone number selects the WhatsApp path; an email address alone selects the email path.

notify_delay and reply_delay override the delays the chat intro configures for this lead only. reply_delay holds back the message to the enquirer. notify_delay holds back the notification to the agent. When both legs carry the same delay, the enquirer is always messaged first.

The response echoes the accepted lead under data. The echo is the stored payload, so it carries the values the API resolved: listing.url and extra_variable_data.Link are filled in from the chat intro when the request left them out, and a validated a-party template override appears as aparty_notify_data.

Request

Path Params

Body Params application/json

Examples

Phone enquirer, no overridesEmail enquirerDelays, tracking data and an a-party template override

{
    "enquirer": {
        "enquirer_name": "Jordan Blake",
        "enquirer_phone_number": "27820000000"
    },
    "listing": {
        "reference_id": "REF-0001"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢202Accepted

application/json

The lead was accepted and queued.

Bodyapplication/json

Example

{
    "uuid": "3f6a1c22-0000-4b00-8000-9c1d2e3f4a5b",
    "data": {
        "id": "5c9f2b41-0000-4a00-9000-1f0a2b3c4d5e",
        "enquirer": {},
        "listing": {
            "reference_id": "REF-0001",
            "url": "https://example.com/listings/REF-0001"
        },
        "meta_data": {
            "source": "Portal",
            "enquiry_type": "Sales"
        },
        "extra_variable_data": {
            "agent_name": "Sam Nkosi",
            "Link": "https://example.com/listings/REF-0001"
        },
        "extra_info": {
            "property1": "string",
            "property2": "string"
        },
        "notify_delay": 60,
        "reply_delay": 30,
        "aparty_notify_whatsapp_template_name": "lead_conversation_start",
        "aparty_notify_whatsapp_template_components": []
    },
    "whatsapp_number": "27820000001",
    "created": "2026-08-20T09:14:52.418000Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠429Too Many Requests