Z-API WhatsApp icon

Z-API WhatsApp

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

Chat → Pin Chat

AI-generated

Summary

Pin a chat for a contact.

Inputs

  • phone (required) — Phone number of the contact whose chat will be modified, in international format (digits only). Example: 5544999999999.

Output shape

An array containing a single object with a json field holding the API response.

The response may include status code and other data; errors are thrown and not wrapped in a success envelope.

Examples

Example 1: Pin a chat for a contact

Set phone to 5544999999999 and choose operation "pinChat" from the node's operation dropdown.

Links

Discussion