Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Owners Documents

Update document

Update document (supports partial update)

patch/owners/{ownerId}/documents/{documentId}

Path parameters

ownerIdstring required

Owner id

documentIdstring required

Document id

Request body

namestring
descriptionstring
type'DOCUMENT' | 'CONTRACT' | 'OWNER1099_COPYB' | 'OWNER1099_COPY2'
isSharedboolean
startDatestring date-time

Date in YYYY-MM-DD format

endDatestring date-time

Date in YYYY-MM-DD format

Response

_idstring required
accountIdstring required
ownerIdstring required
originalFileNamestring required
namestring required
descriptionstring
type'DOCUMENT' | 'CONTRACT' | 'OWNER1099_COPYB' | 'OWNER1099_COPY2' required
isSharedboolean required

Document is visible to owner in Owners Portal

startDatestring

Document effective date in YYYY-MM-DD format

endDatestring

Document expiration date in YYYY-MM-DD format

createdAtstring date-time required
deletedAtstring date-time

Example response

{
  "type": "DOCUMENT"
}