Skip to main content
PATCH
Update link-type document

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization that owns the records.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
document_id
string<shortuuid>
required

ID of the document.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

Payload to change a GDTI document. Send only the fields you are changing.

gdti
string | null

Global Document Type Identifier (AI 253), 13 to 30 digits. Unique across Closient.

Maximum string length: 30
Pattern: ^[^\x00]{0,30}$
document_type
enum<string> | null

Coarse classification of the document.

Available options:
CERTIFICATE,
INVOICE,
SPECIFICATION,
COMPLIANCE_REPORT,
OTHER
title
string | null

Display title of the document (max 255 characters).

Maximum string length: 255
Pattern: ^[^\x00]{0,255}$
external_url
string | null

Where the document lives: an absolute http(s) URL of at most 2048 characters. Send null to clear it.

Maximum string length: 2048
Pattern: ^[Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,2039}$
issued_date
string<date> | null

Date the document was issued (YYYY-MM-DD). Send null to clear.

Response

OK

A GDTI document as read from the API.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gdti
string
required

Global Document Type Identifier (AI 253), 13 to 30 digits. Unique across Closient.

document_type
enum<string>
required

Coarse classification of the document.

Available options:
CERTIFICATE,
INVOICE,
SPECIFICATION,
COMPLIANCE_REPORT,
OTHER
title
string
required

Display title of the document (max 255 characters).

organization_id
string<shortuuid>
required

UUID of the organization that owns the document.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
created
string<date-time>
required

ISO-8601 creation timestamp.

modified
string<date-time>
required

ISO-8601 last-modified timestamp.

file_url
string | null

URL of the hosted file, if one was uploaded in the dashboard. Read-only here.

external_url
string | null

Where the document lives, if hosted elsewhere.

issued_date
string<date> | null

Date the document was issued, or null.