Skip to main content
PUT
/
api
/
projects
/
{projectId}
/
documents
/
{documentId}
/
versions
/
{versionId}
/
rename
Rename a version
curl --request PUT \
  --url https://api.example.com/api/projects/{projectId}/documents/{documentId}/versions/{versionId}/rename \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
import requests

url = "https://api.example.com/api/projects/{projectId}/documents/{documentId}/versions/{versionId}/rename"

payload = { "name": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};

fetch('https://api.example.com/api/projects/{projectId}/documents/{documentId}/versions/{versionId}/rename', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/projects/{projectId}/documents/{documentId}/versions/{versionId}/rename",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/projects/{projectId}/documents/{documentId}/versions/{versionId}/rename"

payload := strings.NewReader("{\n \"name\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.example.com/api/projects/{projectId}/documents/{documentId}/versions/{versionId}/rename")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/projects/{projectId}/documents/{documentId}/versions/{versionId}/rename")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "content": "<unknown>",
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdBy": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "createdAt": "<string>",
  "versions": [
    "<unknown>"
  ],
  "releases": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

documentId
string<uuid>
required

Document unique identifier

projectId
string<uuid>
required

Project unique identifier

versionId
string<uuid>
required

Version unique identifier

Body

application/json
name
string | null

New version name (null to clear)

Response

200 - application/json

Updated document version

Updated document version

id
string<uuid>
required

Version unique identifier

name
string | null

Version name

parentId
string<uuid> | null

Parent version ID for sub-versions

status
string

Version status (draft or completed)

content
any

Version content data

documentId
string<uuid>

Associated document ID

createdBy
object

User who created the version

createdAt
string

Version creation timestamp

versions
any[]

Sub-versions (recursive structure)

releases
object[]

Associated releases