WhatsApp Gateway icon

WhatsApp Gateway

Envia mensagens e gerencia sessões/contatos no WhatsApp Gateway

Actions27

Contact → Block

AI-generated

Summary

Block a contact on WhatsApp by specifying their phone number or JID within a given WhatsApp session.

Inputs

  • Session (Name or ID) (required) — The WhatsApp session's name or ID in which to block the contact.
  • Number or JID (required) — Phone number (country code + area code) or canonical JID of the contact to be blocked.
  • Request Options — Optional settings such as batching, SSL certificate validation behavior, proxy, and timeout for the HTTP request.

Output shape

a single record confirming the block action or an error response

The operation sends a POST request to the endpoint /api/sessions/{session}/contacts/block with the required contact identifier in the body. It does not explicitly define the response schema beyond standard API error handling.

Links

Discussion