Update document version status
Publish an existing draft version or move an archived version back into draft/published state.
Use /versions/{versionId}/activate after publishing to make a version the promoted default.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Document ID
Format
uuidversionId*string
Version ID
Format
uuidRequest Body
application/json
status*string
Target status for the version.
Value in
"draft" | "published" | "archived"Response Body
application/json
application/json
application/json
application/json
package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://app.orbiqhq.com/api/v1/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/497f6eca-6276-4993-bfeb-53cbbbba6f08" body := strings.NewReader(`{ "status": "published" }`) req, _ := http.NewRequest("PATCH", url, body) req.Header.Add("Content-Type", "application/json") 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": "b9db1e63-3c9c-4b37-a1b1-29d9a7df0a46",
"key": "draft_1714502400000",
"name": "Q2 Refresh",
"status": "published",
"is_active": false,
"date_created": "2025-04-30T09:30:00Z",
"date_updated": "2025-05-01T08:15: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?