RyzeAPI icon

RyzeAPI

Send WhatsApp messages and manage your RyzeAPI instances

Chat → Pin Message

AI-generated

Summary

Pin or unpin a message in a chat on a specified WhatsApp instance, optionally setting the duration for which the message remains pinned.

Inputs

  • Instance Name or ID (required) — Select or specify the WhatsApp instance to operate on.
  • Message ID (required) — Provide the ID of the message to pin or unpin; the chat context is resolved automatically.
  • Pin (required) — Boolean to specify whether to pin (true) or unpin (false) the message.
  • Duration — If pinning, choose how long the message will stay pinned; options are 24h, 7d (default), or 30d.

Output shape

The operation returns a JSON object with the API's response indicating the result of the pin or unpin action.

No pagination or multiple items are returned; the response depends on the underlying API endpoint's success or failure.

Links

Discussion