Actions21
- Assistant Actions
- Callback Actions
- Chat Actions
- File Actions
- Message Actions
- Peer Agent Actions
Message → Pin or Unpin a Message
AI-generatedSummary
Pin or unpin a Home of Agents chat message by setting its pinned state. Pinned messages appear in the chat’s pin bar.
Inputs
- Message ID (required) — ID of the message to change. If left empty, the operation uses
message_idormessageIdfrom the input item, ormessage.id. - Is Pinned — Set to
trueto pin (default) orfalseto unpin the message.
Output shape
A single item containing the input JSON merged with the API response.
The operation updates the pin state through the BGOS API. If Continue On Fail is enabled, a failure returns the input JSON with
success: falseand anerrormessage.