PIpipeshub-ai
Conversations

Unpin conversation

Changed on

Remove a conversation's pin so it is listed by recent activity again.

Access:

Owner only, as for PATCH /conversations/{conversationId}/pin.

Behaviour:

Idempotent: unpinning a conversation that is not pinned succeeds and changes nothing.

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

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/conversations/{conversationId}/unpin
  • 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 not pinned

idstring objectId required

Conversation identifier

isPinnedboolean required

The conversation's pin state after the call.

Changes

  • dbb5e203b445Revision 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

  • a90ab79f26a1Revision changes
    • info

      endpoint added