message

send vCard

Send a vCard to a contact or group.

post/instances/{id}/client/action/send-vcard

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/send-vcard
  • Auth: HTTP bearer

Path parameters

idinteger required

The ID of the instance.

Request body

chatIdstring required

Chat ID <countrycode_short><usernumber>@c.us or @g.us for groups

firedandforgetboolean

Set to true to process the request asynchronously. Returns a reference UUID for polling via GET /instances/{id}/request/{reference}. Alias: faf

Example request

{
  "chatId": "50664083362@c.us",
  "vCard": {
    "waid": "xxxxxxxxxxxx",
    "internationalnumber": "+15551234567",
    "lastname": "Doe",
    "firstname": "John",
    "displayname": "John Doe",
    "title": "Mr.",
    "organization": "Example Corp",
    "email": "john.doe@example.com",
    "street": "123 Main St",
    "city": "Anytown",
    "zip": "12345",
    "state": "CA",
    "country": "USA",
    "website": "https://example.com"
  }
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Vcard sent successfully.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "data": {
    "status": "success",
    "data": {
      "sendVcard": true
    }
  },
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.