Send a contact card

curl --request POST \
  --url https://api.wsapi.chat/messages/contact \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "to": "1234567890@s.whatsapp.net",
  "displayName": "Jane Doe"
}
'

{
  "id": "01234567890123456"
}

{
  "status": 400,
  "detail": "invalid request body"
}

{
  "status": 401,
  "detail": "unauthorized"
}

{
  "status": 403,
  "detail": "device not paired"
}

{
  "status": 503,
  "detail": "instance not available"
}

POST

messages

contact

curl --request POST \
  --url https://api.wsapi.chat/messages/contact \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "to": "1234567890@s.whatsapp.net",
  "displayName": "Jane Doe"
}
'

{
  "id": "01234567890123456"
}

{
  "status": 400,
  "detail": "invalid request body"
}

{
  "status": 401,
  "detail": "unauthorized"
}

{
  "status": 403,
  "detail": "device not paired"
}

{
  "status": 503,
  "detail": "instance not available"
}

Authorizations

X-Api-Key

string

header

required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

X-Instance-Id

string

default:{{instanceId}}

required

The ID of the WhatsApp instance to use

Body

application/json

string

required

displayName

string

Contact display name

vcard

string

vCard string

mentions

string[]

replyTo

string

replyToSenderId

string

isForwarded

boolean

ephemeralExpiration

enum<string>

Available options:

off,

24h,

7d,

90d

Response

Resource created

string

ID of the created resource

Send a sticker message

Send a location message

Overview

Endpoints

Authorizations

Headers

Body

Response