Documents

Link documents to a document

States that documents go together — a completion certificate and the signed contract, an invoice and its order, an annex and its contract. A link is undirected (both documents list each other) and sits beside the records: neither document changes, so this is allowed on sealed documents too. Linking a pair that is already linked changes nothing. At most 20 documents per call; each must be one the caller can see. Refused when the caller may only read the class of the document named in id.

post/api/v1/rest/documents/{id}/links

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/documents/{id}/links
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The document to link from.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Request body

linked_idsstring[] required

The documents that go with it, from documents_search.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.