Contact cards appear as interactive elements in WhatsApp with an “Add to Contacts” button, making it easy for recipients to save the information.
Endpoint
Headers
Device identifier for multi-device support. Required when multiple devices are registered.
Must be
application/json.Request Body
Phone number with country code and WhatsApp suffix of the recipient.Format:
{country_code}{phone_number}@s.whatsapp.netExample: [email protected]Display name for the contact being shared.Example:
"Aldino Kemal"Phone number of the contact being shared (without WhatsApp suffix).Format:
{country_code}{phone_number} (numbers only, no special characters)Example: "6289685024992"Mark the message as forwarded.
Disappearing message duration in seconds (optional).Common values:
86400- 24 hours604800- 7 days7776000- 90 days
Response
Response status code. Returns
"SUCCESS" on successful send.Human-readable response message.
Code Examples
Response Example
Use Cases
Customer Support
Share support contact information with customers:Sales & Business Development
Introduce team members or sales representatives:Referrals & Networking
Connect people by sharing contact information:Event Coordination
Share event organizer or venue contact:Emergency Contacts
Distribute emergency or important contact information:Contact Card Display
WhatsApp displays contact cards with:- Contact Name: Displayed prominently at the top
- Phone Number: Formatted based on recipient’s locale
- WhatsApp Status: Shows if contact is on WhatsApp
- Action Buttons:
- “Add to Contacts” button
- “Message” button (if contact is on WhatsApp)
- “Call” button
Phone Number Formatting
Correct Format
Recipient Phone (phone):
contact_phone):
Country Codes
Always include the country code without the ”+” symbol:- Indonesia: 62
- United States: 1
- United Kingdom: 44
- India: 91
- Singapore: 65
- Australia: 61
Examples
Best Practices
-
Descriptive Names
- Include role or department: “John Doe - Sales”
- Add company name: “Support - Acme Corp”
- Specify purpose: “Emergency Contact”
-
Verify Phone Numbers
- Double-check country codes
- Remove spaces and special characters
- Validate number format before sending
-
Context Matters
- Send contact cards with explanatory text message
- Explain who the contact is and why you’re sharing
- Follow up to ensure recipient saved the contact
-
Privacy Considerations
- Get permission before sharing someone’s contact
- Use disappearing messages for sensitive contacts
- Be mindful of data protection regulations
-
Group Sharing
- Explain relationship when sharing in groups
- Consider if all group members need the contact
- Respect privacy preferences
Automation Ideas
Welcome Message with Support Contact
Sales Lead Assignment
Event Registration Confirmation
Limitations
WhatsApp contact cards have some inherent limitations.
- Single Contact: Can only send one contact per message
- Basic Info: Only name and phone number supported
- No Email: Email addresses not included in contact cards
- No Address: Physical addresses not supported
- No Organization: Company/organization field not available
- No Notes: Cannot add notes or additional context
Advanced Tips
Multiple Contacts
To share multiple contacts, send them in separate messages:Rich Context
Combine with text messages for context:Error Responses
Common causes:
- Invalid phone number format
- Missing required fields (contact_name or contact_phone)
- Invalid contact_phone format (contains special characters)
- Missing country code in phone numbers
Common causes:
- Device not connected
- Network connectivity issues
- WhatsApp service temporarily unavailable
Troubleshooting
Contact Not Appearing Correctly
- Verify phone number includes country code
- Remove all special characters from contact_phone
- Check contact_name is not empty
- Ensure proper JSON formatting
”Add to Contacts” Not Working
- Check recipient’s device compatibility
- Verify contact_phone format is correct
- Ensure recipient has permission to add contacts
- Try with a different phone number
Contact Shows as Invalid
- Verify country code is correct
- Check phone number is active
- Remove spaces from contact_phone
- Validate number length for country
Related Endpoints
- Send Text - Send text messages
- Send Link - Send links with preview
- Send Location - Share location information
- User Info - Get user information
