SUsurense
Documents

Update a document

Update a document.

patch/documents/{id}

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/documents/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token

Path parameters

idstring uuid required

Document ID

Request body

namestring

Document name

typestring

Document type ID

companyinteger

Company ID

notesstring

Document notes

Example request

{
  "name": "Contract Document",
  "type": "123e4567-e89b-12d3-a456-426614174000",
  "company": 12345,
  "notes": "Important contract document"
}

Response

OK

tenantIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid
employerIdstring uuid
customerIdstring uuid
leadIdstring uuid
leadInterestIdstring uuid
workflowIdstring uuid
workflowTypeIdstring uuid
meetingIdstring uuid
typeIdstring uuid
namestring
nameWithExtensionstring
mimestring
fileExtensionstring
sizeinteger
source'system' | 'appmail' | 'polirobot' | 'manual' | 'openfinance' | 'harel'
backupImport'bafi' | 'roeto' | 'atid' | 'polywizz' | 'other'
systemGeneratedboolean
companyIdinteger
notesstring
appmailReceivedboolean
deletableboolean
editableboolean
bafiFileCatstring

Changes

No recorded changes to this operation across all 1 revision of this API.