GUguesty
Owners Documents

Create a document

Create a document

post/owners/{ownerId}/documents

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/owners/{ownerId}/documents
  • Auth
    API key in header authorization

Path parameters

ownerIdstring required

Owner id

Request body multipart/form-data

filestring binary required

Document in pdf format, maximum size 5 MB

namestring required
descriptionstring
type'DOCUMENT' | 'CONTRACT' | 'OWNER1099_COPYB' | 'OWNER1099_COPY2'

Type of the document, defaults to DOCUMENT

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"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.