PUT
/
v0
/
documents
/
{id}
/
versions
/
{versionNumber}
/
activate
Activate a specific version of a document
curl --request PUT \
  --url https://api.avidoai.com/v0/documents/{id}/versions/{versionNumber}/activate \
  --header 'x-api-key: <api-key>'
{
  "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",
    "activeVersionId": "321e4567-e89b-12d3-a456-426614174001",
    "scrapeJobId": null,
    "activeVersion": {
      "id": "321e4567-e89b-12d3-a456-426614174001",
      "versionNumber": 1,
      "title": "API Documentation",
      "content": "Initial API documentation...",
      "status": "APPROVED"
    }
  },
  "previousActiveVersion": {
    "id": "321e4567-e89b-12d3-a456-426614174002",
    "versionNumber": 2,
    "title": "API Documentation v2",
    "content": "Updated API documentation...",
    "status": "APPROVED"
  },
  "newActiveVersion": {
    "id": "321e4567-e89b-12d3-a456-426614174001",
    "versionNumber": 1,
    "title": "API Documentation",
    "content": "Initial API documentation...",
    "status": "APPROVED"
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

Path Parameters

​
id
string<uuid>
required

The unique identifier of the document

Example:

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

​
versionNumber
integer
required

The version number to activate

Required range: x >= 1
Example:

2

Response

Version activated successfully

Response after activating a document version