Skip to main content
POST
/
api
/
contacts
/
block
Block contact
curl --request POST \
  --url https://{host}/api/contacts/block \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "contactId": "[email protected]",
  "session": "my-session"
}
'
{
  "success": true,
  "message": "Contact blocked successfully"
}

​
Description

This endpoint allows blocking a specific contact on WhatsApp. ⚠️ This endpoint is not yet implemented.

​
Body

{
  "sessionId": "my-session",
  "jid": "[email protected]"
}

​
Body Parameters

PropertyTypeRequiredDescription
sessionIdstring✅ YesAuthenticated session ID
jidstring✅ YesContact identifier to be blocked (WhatsApp JID). Format: [email protected]
{
  "success": true,
  "message": "Contact blocked successfully"
}

​
Status Codes

  • 200 - Contact blocked successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized session
  • 404 - Session not found
  • 501 - Endpoint not implemented

​
Usage Example

curl -X POST https://api.wappfy.com.br/api/contacts/block \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "my-session",
    "jid": "[email protected]"
  }'

Authorizations

​
apikey
string
header
required

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

Body

application/json
​
contactId
string
required

Contact identifier (WhatsApp JID)

Example:

"[email protected]"

​
session
string
required

Session name (instanceName)

Example:

"my-session"

Response

201 - undefined