Documents
Create a document version
Requires documentsHubEnabled. Generic reads, permanent DELETE, and archive-state PATCH are available without that flag. Requires document update permission.
POST
/
document
/
{id}
/
versions
Create a document version
curl --request POST \
--url https://{instance}/api/v2/document/{id}/versions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"documentKey": "<string>",
"documentUrl": "<string>",
"versionLabel": "<string>",
"mimeType": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
documentKey: '<string>',
documentUrl: '<string>',
versionLabel: '<string>',
mimeType: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://{instance}/api/v2/document/{id}/versions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/document/{id}/versions"
payload = {
"name": "<string>",
"documentKey": "<string>",
"documentUrl": "<string>",
"versionLabel": "<string>",
"mimeType": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"value": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versionLabel": "<string>",
"name": "<string>",
"documentKey": "<string>",
"documentUrl": "<string>",
"mimeType": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"metadata": {},
"isArchived": true,
"appUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}Authorizations
Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.
Path Parameters
Body
application/json
Response
Successful response.
Show child attributes
Show child attributes
⌘I
Create a document version
curl --request POST \
--url https://{instance}/api/v2/document/{id}/versions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"documentKey": "<string>",
"documentUrl": "<string>",
"versionLabel": "<string>",
"mimeType": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
documentKey: '<string>',
documentUrl: '<string>',
versionLabel: '<string>',
mimeType: '<string>',
lastModifiedAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://{instance}/api/v2/document/{id}/versions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/document/{id}/versions"
payload = {
"name": "<string>",
"documentKey": "<string>",
"documentUrl": "<string>",
"versionLabel": "<string>",
"mimeType": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"value": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versionLabel": "<string>",
"name": "<string>",
"documentKey": "<string>",
"documentUrl": "<string>",
"mimeType": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"metadata": {},
"isArchived": true,
"appUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}