RyzeAPI icon

RyzeAPI

Send WhatsApp messages and manage your RyzeAPI instances

Chat → Favorite

AI-generated

Summary

Mark or unmark a chat or message as a favorite in a specified WhatsApp instance.

Inputs

  • Instance Name or ID (required) — Select the WhatsApp instance to operate on from the list or specify its ID using an expression.
  • Target (required) — Choose whether to favorite a chat or a message.
  • Number (required) — Provide the chat identifier (phone number, JID, group, or newsletter) when favoriting a chat.
  • Message ID (required) — Specify the message ID to favorite when targeting a message; the chat is resolved automatically.
  • Favorite (required) — Boolean to set the target as favorite (true) or remove it from favorites (false).

Output shape

a single JSON object representing the API response indicating the success or failure of the favorite action.

The operation returns the raw API response; no pagination or additional metadata is included.

Links

Discussion