Skip to Content
Documents

Link document to another document

POST
/api/v1/documents/{id}/links

Create a link from this document to another document in the same organization.

Required Fields:

  • toDocumentId - The document to link to
  • linkType - 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.

Authorization

headerAuthorizationBearer <token>

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Path Parameters

id*string

The document ID.

Header Parameters

Sajn-Version?string

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.

Value in"2026-09""2026-10"
Sajn-Workspace?string

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.

Idempotency-Key?string

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.

Lengthlength <= 255

Request Body

Body

application/json
  1. body
toDocumentId*string

The document to link to (the older/passive end)

Length1 <= length
linkType*string

How this document relates to the target

Value in"AMENDS""REPLACES""RENEWS""RELATES_TO"

Response Body

200

application/json
  1. response
id*string

Link ID

fromDocumentId*string

ID of the document that acts on the other one. For RELATES_TO, which has no direction, either end.

toDocumentId*string

ID of the document the from-document acts on

linkType*string

How the documents relate: the from-document AMENDS/REPLACES/RENEWS/RELATES_TO the to-document

Value in"AMENDS""REPLACES""RENEWS""RELATES_TO"
direction*string

Which end of the link this document is — FROM means this document is the acting/newer one

Value in"FROM""TO"
origin*|

How the link was created: MANUAL, DUPLICATE, or RENEWAL

createdAt*string

When the link was created

Formatdate-time
target*|

The other end of the link; null when that document has been moved to trash

Example Request
curl -X POST 'https://app.sajn.se/api/v1/documents/cm4k2x9p10003abcd1234efgh/links' \  -H 'Content-Type: application/json' \  -d '{  "toDocumentId": "cm4k2x9p10022abcd1234efgh",  "linkType": "AMENDS"}'
Example Response
{  "id": "cm4k2x9p10021abcd1234efgh",  "fromDocumentId": "cm4k2x9p10003abcd1234efgh",  "toDocumentId": "cm4k2x9p10022abcd1234efgh",  "linkType": "AMENDS",  "direction": "FROM",  "origin": "manual",  "createdAt": "2026-09-28T09:12:00.000Z",  "target": {    "id": "cm4k2x9p10022abcd1234efgh",    "name": "Sekretessavtal – Kai Lindqvist",    "status": "COMPLETED",    "workspaceId": "cm4k2x9p10001abcd1234efgh"  }}

Was this page helpful?