Skip to main content
POST
/
api
/
sendContactVcard
cURL
curl --request POST \
  --url https://{host}/api/sendContactVcard \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "chatId": "[email protected]",
  "contacts": [
    {
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:Jane Doe\nORG:Company Name;\nTEL;type=CELL;type=VOICE;waid=911111111111:+91 11111 11111\nEND:VCARD"
    }
  ],
  "reply_to": null,
  "session": "my-session"
}'
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Description

This endpoint allows you to send one or more contacts in vCard format to individual contacts or groups on WhatsApp. Contacts are sent with display name and information in vCard standard format.

​
Body

{
  "sessionId": "my-session",
  "jid": "[email protected]",
  "contacts": [
    {
      "displayName": "João Silva",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:João Silva\nTEL;type=CELL;type=VOICE;waid=5511988887777:+55 11 98888-7777\nEND:VCARD"
    }
  ]
}

​
Body Parameters

PropertyTypeRequiredDescription
sessionIdstring✅ YesAuthenticated session ID that will send the contacts
jidstring✅ YesRecipient identifier (WhatsApp JID). Format: [email protected] for contacts or [email protected] for groups
contactsarray✅ YesArray of contact objects
contacts[].displayNamestring✅ YesContact display name
contacts[].vcardstring✅ YesContact data in vCard format (version 3.0)
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Status Codes

  • 200 - Contact(s) sent successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized session
  • 404 - Session not found

​
Usage Example

curl -X POST https://api.wappfy.com.br/api/sendContactVcard \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "my-session",
    "jid": "[email protected]",
    "contacts": [
      {
        "displayName": "João Silva",
        "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:João Silva\nTEL;type=CELL;type=VOICE;waid=5511988887777:+55 11 98888-7777\nEND:VCARD"
      }
    ]
  }'

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Body

application/json
​
chatId
string
required

Chat ID (WhatsApp JID)

Example:

"[email protected]"

​
contacts
object[]
required

Array of contacts in vCard format

  • Option 1
  • Option 2
​
session
string
required

Session name (instanceName)

Example:

"my-session"

​
reply_to
string

Message ID you want to reply to

Example:

null