Company logoTrust Center Documentation
API v1 ReferenceDocumentsIdVersionsVersionidActivate

Activate a published document version

Marks the specified published version as active and updates the document's status to published/valid. All other versions are marked as inactive.

POST
/api/v1/documents/{id}/versions/{versionId}/activate

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Document ID

Formatuuid
versionId*string

Version ID to activate

Formatuuid

Response Body

application/json

application/json

application/json

application/json

package mainimport (  "fmt"  "net/http"  "io/ioutil")func main() {  url := "https://app.orbiqhq.com/api/v1/documents/3fa85f64-5717-4562-b3fc-2c963f66afa6/versions/3fa85f64-5717-4562-b3fc-2c963f66afa6/activate"  req, _ := http.NewRequest("POST", url, nil)    res, _ := http.DefaultClient.Do(req)  defer res.Body.Close()  body, _ := ioutil.ReadAll(res.Body)  fmt.Println(res)  fmt.Println(string(body))}
{
  "success": true,
  "data": {
    "version": {
      "id": "c1d915ec-b9d2-4065-92c7-d0fe92ad32be",
      "key": "draft_1714502400000",
      "name": "Q2 Refresh",
      "status": "published",
      "is_active": true,
      "date_created": "2025-04-30T09:30:00Z",
      "date_updated": "2025-05-02T11:05:00Z",
      "modified_fields": [
        "description",
        "file"
      ]
    }
  }
}
{
  "type": "string",
  "code": "string",
  "message": "string",
  "doc_url": "string"
}
Empty
{
  "type": "string",
  "code": "string",
  "message": "string",
  "doc_url": "string"
}
{
  "type": "string",
  "code": "string",
  "message": "string",
  "doc_url": "string"
}
Empty

How is this guide?