Conversations

Pin conversation

Changed on

Pin a conversation so it is listed first in the caller's own conversation list.

Access:

Owner only: the caller must be the conversation's initiator. People the conversation is shared with, even with write access, cannot pin it, and their own lists are not affected by the owner's pin.

Behaviour:

Idempotent: pinning an already pinned conversation succeeds and changes nothing. Archived and deleted conversations cannot be pinned. Archiving a pinned conversation removes its pin. Pinning does not change lastActivityAt or updatedAt, so the conversation keeps its place among the other pinned chats.

  • Path params: conversationId
  • Query params: none
  • Body: none
patch/conversations/{conversationId}/pin

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/conversations/{conversationId}/pin
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: conversation:write

Path parameters

conversationIdstring objectId required

Conversation identifier

Response

Conversation is pinned

idstring objectId required

Conversation identifier

isPinnedboolean required

The conversation's pin state after the call.

Changes

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      endpoint added