Update a document

Updated: November 2, 2026

PUT/plm/{connection_id}/document/{id}

Updates the PlmDocument identified by id. Provide the unified PlmDocument fields to change in the request body.

Parameters

Payload

One revision of an engineering document

idstring

created_atdate-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

master_identifierstring

Vendor ID shared by every revision of the same document; not a unified object

numberstring

namestring

descriptionstring

revisionstring

status enum

Valid values:

"IN_WORK"

"IN_REVIEW"

"RELEASED"

"OBSOLETE"

"OTHER"

Normalized lifecycle status of a part or document revision

lifecycle_statestring

type enum

Valid values:

"DRAWING"

"CAD_MODEL"

"SPECIFICATION"

"PROCEDURE"

"REPORT"

"OTHER"

Normalized document type

original_typestring

The vendor's own document type name

category_idstring

The PlmCategory the document is filed under (reference to AccountingCategory)

part_idsstring array

Related PlmPart IDs

file_idsstring array

Attachment IDs retrievable from StorageFile

user_idstring

(reference to HrisEmployee)

urlstring

metadata array

raw

Raw data from integration

Returns

PlmDocument

Response field	Type	Required	Description
`id`	string	No
`created_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`master_identifier`	string	No	Vendor ID shared by every revision of the same document; not a unified object
`number`	string	No
`name`	string	No
`description`	string	No
`revision`	string	No
`status`	enum	No	Normalized lifecycle status of a part or document revision Values: `IN_WORK`, `IN_REVIEW`, `RELEASED`, `OBSOLETE`, `OTHER`
`lifecycle_state`	string	No
`type`	enum	No	Normalized document type Values: `DRAWING`, `CAD_MODEL`, `SPECIFICATION`, `PROCEDURE`, `REPORT`, `OTHER`
`original_type`	string	No	The vendor's own document type name
`category_id`	string	No	The PlmCategory the document is filed under (reference to AccountingCategory)
`part_ids`	string[]	No	Related PlmPart IDs
`file_ids`	string[]	No	Attachment IDs retrievable from StorageFile
`user_id`	string	No	(reference to HrisEmployee)
`url`	string	No
`metadata`	PlmMetadata[]	No
`metadata[].id`	string	No	The ID of the custom field definition (from the metadata/metadata endpoint).
`metadata[].slug`	string	No	The integration's API name (key) of an existing custom field.
`metadata[].value`	object	No	The field's value, typed by `format`.
`metadata[].namespace`	string	No
`metadata[].format`	enum	No	The data type of the custom field, which determines how `value` is formatted. Values: `TEXT`, `NUMBER`, `DATE`, `BOOLEAN`, `FILE`, `TEXTAREA`, `SINGLE_SELECT`, `MULTIPLE_SELECT`, `MEASUREMENT`, `PRICE`, `YES_NO`, `CURRENCY`, `URL`
`metadata[].extra_data`	object	No

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.plm.updatePlmDocument({ connectionId, id, plmDocument: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("PUT", "https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

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

url := `https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw=

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

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

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

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

Python

import requests

url = "https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

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

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw=")

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

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request PUT \
  --url 'https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?