Update document - SquadVault

PATCH

/

documents

/

{documentId}

Update document

curl --request PATCH \
  --url https://api.squadvault.xyz/v1/documents/{documentId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Playbook Q3 (Final)",
  "tags": [
    "playbook",
    "management"
  ]
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Playbook Q3 (Final)', tags: ['playbook', 'management']})
};

fetch('https://api.squadvault.xyz/v1/documents/{documentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.squadvault.xyz/v1/documents/{documentId}"

payload = {
    "name": "Playbook Q3 (Final)",
    "tags": ["playbook", "management"]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "organizationId": "<string>",
  "teamId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "fileUrl": "<string>",
  "fileKey": "<string>",
  "contentType": "<string>",
  "sizeBytes": 123,
  "uploadedBy": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "tags": [
    "playbook"
  ],
  "team": {
    "id": "<string>",
    "name": "<string>"
  },
  "uploadedByUser": {
    "id": "<string>",
    "name": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

Organization API key from Settings → API keys.

Path Parameters

documentId

string

required

Body

application/json

To replace the file, send fileKey, fileUrl, contentType, and sizeBytes together.

name

string

description

string | null

tags

enum<string>[]

Available options:

playbook,

contract,

management,

content,

legal,

other

teamId

string | null

fileKey

string

fileUrl

string<uri>

contentType

enum<string>

Available options:

application/pdf,

application/msword,

application/vnd.openxmlformats-officedocument.wordprocessingml.document,

application/vnd.ms-excel,

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,

text/plain,

image/jpeg,

image/png,

image/webp,

image/gif

sizeBytes

integer

Required range: 1 <= x <= 26214400

Response

Updated document

id

string

organizationId

string

teamId

string | null

name

string

description

string | null

fileUrl

string

fileKey

string

contentType

string

sizeBytes

integer

uploadedBy

string | null

createdAt

string<date-time>

updatedAt

string<date-time>

tags

enum<string>[]

Available options:

playbook,

contract,

management,

content,

legal,

other

team

object | null

Show child attributes

uploadedByUser

object | null

Show child attributes

Update document

curl --request PATCH \
  --url https://api.squadvault.xyz/v1/documents/{documentId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Playbook Q3 (Final)",
  "tags": [
    "playbook",
    "management"
  ]
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Playbook Q3 (Final)', tags: ['playbook', 'management']})
};

fetch('https://api.squadvault.xyz/v1/documents/{documentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.squadvault.xyz/v1/documents/{documentId}"

payload = {
    "name": "Playbook Q3 (Final)",
    "tags": ["playbook", "management"]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "organizationId": "<string>",
  "teamId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "fileUrl": "<string>",
  "fileKey": "<string>",
  "contentType": "<string>",
  "sizeBytes": 123,
  "uploadedBy": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "tags": [
    "playbook"
  ],
  "team": {
    "id": "<string>",
    "name": "<string>"
  },
  "uploadedByUser": {
    "id": "<string>",
    "name": "<string>"
  }
}