Activate a specific version of a document

Makes a specific version the active version of a document. This is the version that will be returned by default when fetching the document.

PUT /v0/documents/{id}/versions/{versionNumber}/activate

JavaScript

JavaScript

import Avido from 'avido';

const client = new Avido({
  apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
  applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
});

const response = await client.documents.activate(2, { id: '123e4567-e89b-12d3-a456-426614174000' });

console.log(response.document);

200

{
  "document": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-07T12:34:56.789Z",
    "orgId": "org_123456789",
    "assignee": "user_123456789",
    "scrapeJobId": null
  },
  "newActiveVersion": {
    "id": "321e4567-e89b-12d3-a456-426614174001",
    "versionNumber": 1,
    "title": "API Documentation",
    "content": "Initial API documentation...",
    "status": "ACTIVE"
  }
}

Authorizations

x-api-key · string · header · required

Your unique Avido API key

x-application-id · string · header · required

Your unique Avido Application ID

Path Parameters

id · string<uuid> · required

The unique identifier of the document

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

"123e4567-e89b-12d3-a456-426614174000"

versionNumber · integer · required

The version number

Required range: x <= 9007199254740991

Example:

2

Response

200

application/json

Version activated successfully

Response after activating a document version

document · object · required

Show child attributes

newActiveVersion · DocumentVersion · object · required

A specific version of a document with its content and metadata

Show child attributes