PIpipeshub-ai
Conversations

Unarchive conversation

Changed on

Restore an archived conversation.

  • Path params: conversationId
  • Query params: none
  • Body: none

Access:

Only the conversation's owner can unarchive 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. A conversation that is not archived returns 400.

patch/conversations/{conversationId}/unarchive

Request

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

idstring objectId

Conversation identifier

status'unarchived'

New archive status of the conversation

unarchivedBystring objectId

User who unarchived the conversation

unarchivedAtstring date-time

Timestamp when the conversation was unarchived

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