Create Vendor File: Propertyware

POST

/v1/vendors/propertyware/:vendor_id/file-upload/

POST

/v1/vendors/propertyware/:vendor_id/file-upload/

curl -X POST https://api.propexo.com/v1/vendors/propertyware/vendor_id/file-upload/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
  "attachment": {
    "file_data": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQgY29udGVudC4=",
    "file_name": "vendor_contract.pdf",
    "mime_type": "application/pdf"
  }
}'

{
  "meta": {
    "job_id": "job_1234567890abcdef"
  },
  "result": {
    "integration_id": "intg_9f8b7c6d5e4a3b2c1d0e",
    "vendor_id": "vend_abcdef1234567890",
    "attachment": {
      "file_name": "vendor_contract.pdf",
      "mime_type": "application/pdf",
      "file_data": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQgY29udGVudC4="
    },
    "notes": "Signed contract for vendor services dated April 2024.",
    "is_private": true
  }
}

Create Vendor File: Propertyware

Method
attachDocumentToVendor

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

vendor_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 vendor

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