PIpipeshub-ai
Conversations

Archive conversation

Changed on

Archive a conversation to hide it from the main list.

Overview:

Archived conversations are preserved but hidden from the default conversation list. Use archiving to clean up your workspace without permanently deleting conversations.

Access:

Only the conversation's owner can archive it: the lookup filters on the caller's userId. It also has a branch for users the conversation is shared with at write access, but that branch can never match, so such users get 404 (a known defect). A missing, deleted or agent conversation is 404 too. Already-archived conversations return 400.

Retrieval:

View archived conversations using GET /conversations/show/archives. Restore one with PATCH /conversations/{conversationId}/unarchive.

patch/conversations/{conversationId}/archive

Request

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

idstring objectId

Conversation identifier

status'archived'

New archive status of the conversation

archivedBystring objectId

User who archived the conversation

archivedAtstring date-time

Timestamp when the conversation was archived

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 non-success response with the status

    • info

      added the non-success response with the status