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
Path Parameters
string
required
The name of your WhatsApp instance that you created
Request Body
string
required
The recipient’s WhatsApp number in international format (without + symbol)Example:
5511999999999 for a Brazilian numberarray
required
Array of contact objects to send. You can send multiple contacts in a single message.
integer
Delay before sending the message in millisecondsExample:
1000 for 1 second delayobject
Quote a previous message by providing its key and message object
boolean
Mention all participants in a groupDefault:
falsearray
Array of phone numbers to mention. Each number should be a numeric string.Example:
["5511999999999", "5511888888888"]Response
object
Message key information
object
The sent message object containing the contact data
string
Unix timestamp when the message was sent
string
Message status (e.g., “PENDING”, “SENT”)
Code Examples
Advanced Examples
Send single contact with all fields
Send single contact with all fields
Send multiple contacts at once
Send multiple contacts at once
Send contact with minimal information
Send contact with minimal information
Send contact as reply to message
Send contact as reply to message
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
ThephoneNumber field accepts various formats:
5511999999999(recommended - numbers only)+55 11 99999-9999(with formatting)+5511999999999(with + 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
number
HTTP status code
string
Error description
Common Errors
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.