Link document to another document
Create a link from this document to another document in the same organization.
Required Fields:
toDocumentId- The document to link tolinkType- AMENDS, REPLACES, RENEWS or RELATES_TO (this document acts on the target)
Both documents must be accessible to the acting user. RELATES_TO is symmetric — the same pair can only be related once regardless of direction.
Response: Returns the link in the shape of an item from GET /api/v1/documents/:id/links.
Authorizations
Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.
Headers
API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.
2026-09, 2026-10 ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.
Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.
255Path Parameters
The document ID.
Body
Body
Response
200
Link ID
ID of the document that acts on the other one. For RELATES_TO, which has no direction, either end.
ID of the document the from-document acts on
How the documents relate: the from-document AMENDS/REPLACES/RENEWS/RELATES_TO the to-document
AMENDS, REPLACES, RENEWS, RELATES_TO Which end of the link this document is — FROM means this document is the acting/newer one
FROM, TO How the link was created: MANUAL, DUPLICATE, or RENEWAL
When the link was created
The other end of the link; null when that document has been moved to trash

