Skip to main content
POST
Restore an archived evidence library document
Restoring a document makes it active again, so Payrails attaches it to new disputes. If every version of the document is archived, Payrails also restores the version that was archived last. Versions that you archived before that stay archived. If the document still has a version that is active, Payrails restores no version.
  • Restoring a document that is not archived returns it unchanged.
  • Returns 404 when the document does not exist, or when the evidenceLibraryEnabled feature flag is off.

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Headers

x-idempotency-key
string<uuid>
required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Path Parameters

documentId
string<uuid>
required

Identifier of the resource in Payrails.

Response

The restored document.

id
string<uuid>
required
kind
enum<string>
required

Kind of library document. terms and policy documents are attached to every dispute; productDescription documents to not-as-described disputes.

Available options:
terms,
policy,
productDescription
title
string
required
attachedTo
enum<string>
required
deprecated

Always allDisputes. Payrails attaches every document to every new dispute.

Available options:
allDisputes
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
usedInCount
integer
required

Number of disputes that use any version of the document. For a caller limited to some workspaces, only disputes in those workspaces count.

workspaceId
string<uuid>

Absent when the document applies to every workspace.

archivedAt
string<date-time>
currentVersion
object

The latest version that is not archived. New disputes get this version. Absent when every version is archived.

lastUsedAt
string<date-time>

When a dispute last started to use a version of the document. For a caller limited to some workspaces, only disputes in those workspaces count.

versions
object[]

All versions of the document, oldest first. Returned by Add document (version 1 only), Get document, Add version, Archive document and Archive version. List documents does not return it.

usages
object[]

The 100 disputes that most recently started to use the document, newest first, with the version each one uses. A dispute that uses two versions appears twice. usedInCount is the total number of disputes. Returned by Get document, Add version, Archive document and Archive version.

Maximum array length: 100