Skip to main content
POST
/
documents
/
{documentId}
/
links
Create document link
curl --request POST \
  --url https://api.vanta.com/v1/documents/{documentId}/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "title": "<string>",
  "description": "<string>",
  "effectiveDate": "2023-11-07T05:31:56Z"
}
'
{
  "id": "1",
  "creationDate": "2024-06-26T00:00:00.000Z",
  "effectiveDate": "2024-07-01T00:00:00.000Z",
  "title": "example link",
  "url": "https://example.com/",
  "description": "example link"
}

Documentation Index

Fetch the complete documentation index at: https://vanta.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
documentId
string
required

Body

application/json
​
url
string
required

The link's URL

​
title
string
required

The link's title.

​
description
string | null

The link's description.

​
effectiveDate
string<date-time> | null

The link's effective date.

Response

201 - application/json

Link created for document

​
id
string
required

The link's unique ID

​
creationDate
string<date-time>
required

The link's creation date.

​
effectiveDate
string<date-time> | null
required

The link's effective date.

​
title
string
required

The link's title.

​
url
string
required

The link's URL.

​
description
string
required

The link's description.