RyzeAPI icon

RyzeAPI

Send WhatsApp messages and manage your RyzeAPI instances

Chat → Pin Chat

AI-generated

Summary

Toggle pin status of a specified chat in a WhatsApp instance, either pinning or unpinning it according to the provided boolean flag.

Inputs

  • Instance Name or ID (required) — Select the WhatsApp instance to operate on by choosing from the list or specifying an ID via expression.
  • Number (required) — Specify the chat identifier to pin or unpin, which can be a phone number, JID, group ID, or newsletter identifier.
  • Pin (required) — Set to true to pin the chat, or false to unpin it.

Output shape

a JSON object confirming the operation result

The output returns confirmation of the pin or unpin action; no pagination or multiple items involved.

Links

Discussion