contact

block a contact

Blocks a contact, preventing them from sending messages to the authenticated user. The contact will not be able to see the user's last seen, online status, or status updates.

post/instances/{id}/client/action/block-contact

Request

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

Path parameters

idinteger required

Instance ID

Request body

contactIdstring required

Contact to block: <number>@c.us or <lid>@lid.

Example request

{
  "contactId": "1234567890@c.us"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Contact blocked 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": {
      "contactId": "1234567890@c.us",
      "blocked": true
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/block-contact"
  },
  "status": "success"
}

Changes

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