API Reference/Documents/Documentid

Update document metadata

PUT
/api/documents/{documentId}
AuthorizationBearer <token>

In: header

Path Parameters

documentIdstring
Format"uuid"
title?string
description?string
tags?array<string>
metadata?object

Empty Object

Response Body

curl -X PUT "http://localhost:3000/api/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Content-Type: application/json" \
  -d '{}'
const body = JSON.stringify({})

fetch("http://localhost:3000/api/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  body
})
package main

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

func main() {
  url := "http://localhost:3000/api/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08"
  body := strings.NewReader(`{}`)
  req, _ := http.NewRequest("PUT", 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))
}
import requests

url = "http://localhost:3000/api/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08"
body = {}
response = requests.request("PUT", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)
{
  "document": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "documentTypeId": "50553e40-12c2-4419-b582-c37b1f8e3bec",
    "title": "string",
    "description": "string",
    "fileName": "string",
    "fileSize": 0,
    "mimeType": "string",
    "currentVersion": 0,
    "status": "draft",
    "tags": [
      "string"
    ],
    "metadata": {},
    "uploadedBy": "1e2815fd-75c7-4289-86d5-2503daeb59b8",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}