Send Contact (vCard)
Supported & TestedSend contact JID cards formatted as vCards.
POSThttps://api.waplix.io/api/v1/messages/vcard
Authentication
Authorization: Bearer YOUR_API_KEY Parameters Specification
| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_id | string | Required | Waplix instance id slot |
| number | string | Required | Recipient phone number |
| contact_name | string | Required | Card display owner name |
| contact_number | string | Required | Card phone details string |
| organization | string | Optional | Optional company organization name |
string | Optional | Optional email details |
instance_id
stringReq Waplix instance id slot
number
stringReq Recipient phone number
contact_name
stringReq Card display owner name
contact_number
stringReq Card phone details string
organization
stringOpt Optional company organization name
email
stringOpt Optional email details
Request Payload Example
Request
curl -X POST "https://api.waplix.io/api/v1/api/v1/messages/vcard" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"instance_id": "demo_instance",
"number": "15551234567",
"contact_name": "John Doe",
"contact_number": "15551234567"
}'Success Response
Response · 200 OK
{
"success": true,
"data": {
"instance_id": "demo_instance",
"to": "15551234567@s.whatsapp.net",
"message_id": "MSG_DEMO_001",
"status": "sent",
"type": "vcard",
"contact_name": "John Doe",
"contact_number": "15551234567",
"organization": null,
"email": null
}
} Related Webhook Events
The API response confirms that Waplix accepted or processed the request. Delivery and read updates may arrive asynchronously through configured webhooks.
message.sentDocs →
Triggered when Waplix successfully sends the contact card (vCard).
{
"event": "message.sent",
"instance_id": "demo_instance",
"to": "15551234567@s.whatsapp.net",
"message_type": "vcard",
"contact_name": "John Doe",
"contact_number": "15551234567",
"organization": null,
"email": null,
"message_id": "MSG_DEMO_001",
"timestamp": 1782582276
}message.deliveredDocs →
Triggered when the contact card is delivered to the recipient.
{
"event": "message.delivered",
"instance_id": "demo_instance",
"message_id": "MSG_DEMO_001",
"chat_id": "15551234567@s.whatsapp.net",
"from": null,
"to": "15551234567@s.whatsapp.net",
"message_type": "vcard",
"status": "DELIVERY_ACK",
"receipts": [],
"timestamp": 1782582278
}message.readDocs →
Triggered when the recipient opens/reads the contact card.
{
"event": "message.read",
"instance_id": "demo_instance",
"message_id": "MSG_DEMO_001",
"chat_id": "15551234567@s.whatsapp.net",
"from": null,
"to": "15551234567@s.whatsapp.net",
"message_type": "vcard",
"status": "READ",
"receipts": [],
"timestamp": 1782582278
} Was this page helpful?