PIpipeshub-ai
Knowledge Base

Restore several deleted records

Changed on

Restore up to 100 records from the trash. Each id is restored as POST /knowledgeBase/record/{recordId}/restore restores it, with everything deleted along with it; ids from one delete are restored once. Every id gets its own outcome in results, so one refusal does not hold the others back, and the answer is 200 whatever the outcomes: with the trash turned off in Labs every id is refused with code: 403 inside a 200. An id listed twice is answered once. Body fields other than recordIds are ignored.

post/knowledgeBase/records/restore

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/knowledgeBase/records/restore
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: kb:delete

Request body

recordIdsstring[] required

Record ids to restore. An id listed more than once is restored, and answered, once.

Response

Outcome for each requested record

successboolean required

True when every requested record was restored

restoredCountinteger required

Records restored, counting those restored along with them

failedCountinteger required

Changes