Create Lease File: Propertyware

POST

/v1/leases/propertyware/:lease_id/file-upload/

POST

/v1/leases/propertyware/:lease_id/file-upload/

curl -X POST https://api.propexo.com/v1/leases/propertyware/lease_id/file-upload/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "propwx-987654321",
  "attachment": {
    "file_data": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQgY29udGVudA==",
    "file_name": "lease_agreement.pdf",
    "mime_type": "application/pdf"
  }
}'

{
  "meta": {
    "job_id": "job-20240615-123456"
  },
  "result": {
    "integration_id": "propwx-987654321",
    "lease_id": "lease-123456789",
    "attachment": {
      "file_name": "lease_agreement.pdf",
      "mime_type": "application/pdf",
      "file_data": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQgY29udGVudA=="
    },
    "notes": "Signed lease agreement uploaded for tenant review.",
    "is_private": true
  }
}

Create Lease File: Propertyware

Method
attachDocumentToLease

Notice

Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

lease_idstringRequired

The ID of the resource.

Request

This endpoint expects an object.

integration_idstringRequired

The Propexo unique identifier for the integration

attachmentobjectRequired

Attachment file on the lease

notesstringOptional

General notes about the file

is_privatebooleanOptional

If the file should be marked as private

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error