Send Contact Message

Send one or multiple contact cards (vCards) to WhatsApp contacts or groups. Recipients can save the contacts directly to their phone’s address book.

Endpoint

POST /message/sendContact/:instanceName

Path Parameters

instanceName

string

required

The name of your WhatsApp instance that you created

Request Body

number

string

required

The recipient’s WhatsApp number in international format (without + symbol)Example: 5511999999999 for a Brazilian number

contact

array

required

Array of contact objects to send. You can send multiple contacts in a single message.

delay

integer

Delay before sending the message in millisecondsExample: 1000 for 1 second delay

quoted

object

Quote a previous message by providing its key and message object

mentionsEveryOne

boolean

Mention all participants in a groupDefault: false

mentioned

array

Array of phone numbers to mention. Each number should be a numeric string.Example: ["5511999999999", "5511888888888"]

Response

key

object

Message key information

message

object

The sent message object containing the contact data

messageTimestamp

string

Unix timestamp when the message was sent

status

string

Message status (e.g., “PENDING”, “SENT”)

Code Examples

curl -X POST https://your-api-url.com/message/sendContact/my-instance \
  -H "Content-Type: application/json" \
  -H "apikey: YOUR_API_KEY" \
  -d '{
    "number": "5511999999999",
    "contact": [
      {
        "fullName": "John Doe",
        "wuid": "5511888888888",
        "phoneNumber": "5511888888888",
        "organization": "Acme Corporation",
        "email": "[email protected]",
        "url": "https://johndoe.com"
      }
    ]
  }'

Advanced Examples

Send single contact with all fields

{
  "number": "5511999999999",
  "contact": [
    {
      "fullName": "John Doe",
      "wuid": "5511888888888",
      "phoneNumber": "5511888888888",
      "organization": "Acme Corporation",
      "email": "[email protected]",
      "url": "https://acme.com"
    }
  ]
}

Send multiple contacts at once

{
  "number": "5511999999999",
  "contact": [
    {
      "fullName": "Sales Team",
      "phoneNumber": "5511888888888",
      "organization": "Acme Corp",
      "email": "[email protected]"
    },
    {
      "fullName": "Support Team",
      "phoneNumber": "5511777777777",
      "organization": "Acme Corp",
      "email": "[email protected]"
    },
    {
      "fullName": "CEO",
      "phoneNumber": "5511666666666",
      "organization": "Acme Corp",
      "email": "[email protected]"
    }
  ]
}

Send contact with minimal information

{
  "number": "5511999999999",
  "contact": [
    {
      "fullName": "Jane Smith",
      "phoneNumber": "5511888888888"
    }
  ]
}

Send contact as reply to message

{
  "number": "5511999999999",
  "contact": [
    {
      "fullName": "Technical Support",
      "phoneNumber": "5511888888888",
      "organization": "Tech Solutions",
      "email": "[email protected]"
    }
  ],
  "quoted": {
    "key": {
      "id": "BAE5F2D3E4F5A6B7",
      "remoteJid": "[email protected]",
      "fromMe": false
    },
    "message": {
      "conversation": "Can you send me the support contact?"
    }
  }
}

Contact Field Guidelines

When sending contact information, only fullName and phoneNumber are required. All other fields are optional but enhance the contact card.

Required Fields

fullName: Cannot be empty. This is the primary identifier for the contact.
phoneNumber: Must be at least 10 digits long.

Optional Fields

wuid: WhatsApp User ID - use this for WhatsApp-specific contacts
organization: Company or organization name
email: Email address (will be validated by WhatsApp client)
url: Website URL (should include http:// or https://)

Phone Number Format

The phoneNumber field accepts various formats:

5511999999999 (recommended - numbers only)
+55 11 99999-9999 (with formatting)
+5511999999999 (with + symbol)

The wuid field should contain only numeric digits and must be at least 10 characters long. This represents the WhatsApp User ID and is typically the phone number in international format without the + symbol.

How Contacts Appear in WhatsApp

When you send a contact message:

Recipients see a contact card with the name and phone number
Optional fields (email, organization, URL) appear if provided
Recipients can tap “Add to Contacts” to save directly to their phone
Multiple contacts appear as separate cards in sequence
Contact information is saved as a vCard (VCF) format

Use Cases

Customer Support: Send support team contact information
Referrals: Share business contacts with potential clients
Event Networking: Share contact details after meetings
Team Coordination: Distribute team member contacts
Service Directories: Send relevant service provider contacts

Error Responses

status

number

HTTP status code

message

string

Error description

Common Errors

Status Code	Error Message	Solution
400	Bad Request - Missing required fields	Ensure `fullName` and `phoneNumber` are provided for each contact
400	”fullName” cannot be empty	Provide a non-empty full name
400	Phone number too short	Ensure phone number is at least 10 digits
400	”wuid” must be a numeric string	Remove non-numeric characters from wuid
401	Unauthorized	Check your API key
404	Not Found	Verify instance exists and is connected
500	Internal Server Error	Check server logs or contact support

You can send up to 5 contacts in a single message for the best user experience. While WhatsApp may support more, keeping it concise improves readability.

Overview

Instance Management

Messaging

Chats

Groups

Contacts

Labels

Settings

Proxy

Send Contact Message