Tables

Pin or unpin a message

Pin (pinned: true) a published message so it is the first thing the next reader of the thread sees, or unpin it (false). Idempotent: pinning a pinned message answers it unchanged. A message that is not published yet is a 409 MESSAGE_NOT_EDITABLE.

post/v1/tables/{tableId}/messages/{messageId}/pin

Request

  • Base URL: https://api.banksync.io
  • URL: https://api.banksync.io/v1/tables/{tableId}/messages/{messageId}/pin
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

tableIdstring required

Table ID

messageIdstring required

Message ID

Request body

pinnedboolean required

Response

The message, pinned or unpinned

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.