Z-API WhatsApp icon

Z-API WhatsApp

Integration with Z-API (WhatsApp) organized by resources (messages, groups, chats, contacts, products, queue, instance, status, etc.).

API → Make API Call

AI-generated

Summary

Make a custom HTTP request to any Z-API endpoint using the selected authentication instance.

Inputs

  • apiCallMethod — HTTP method to use for the request (e.g., GET, POST, PUT, PATCH, DELETE).
  • apiCallEndpoint (required) — Endpoint relative to this instance base URL (e.g. /send-text). You may also paste a full https:// URL.
  • apiCallQuery — Query Parameters
  • apiCallHeaders — Headers to include in the request.
  • apiCallBody — Request body as JSON (ignored for GET/HEAD)
  • apiCallFullResponse — Whether to return statusCode + headers + body

Output shape

HTTP response object (status, headers, and body when Full Response is enabled; otherwise just the response body).

If Full Response is disabled only the response body is returned; errors are thrown as NodeOperationError.

Examples

Example 1: Send a simple text message to a contact.

Resource: API, Operation: Make API Call, Method: POST, Endpoint: /send-text, Body: {"phone":"5511999999999","message":"Hello"}

Example 2: Perform a generic GET request to fetch account information.

Resource: API, Operation: Make API Call, Method: GET, Endpoint: /account/info, Full Response: true

Links

Discussion