Create Service Request File: Propertyware

POSThttps://api.propexo.com/v1/service-requests/propertyware/:service_request_id/file-upload/

Method
attachDocumentToWorkOrder

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

service_request_id stringrequired

The ID of the resource.

Request

This endpoint expects an object.

integration_idstringrequired

The Propexo unique identifier for the integration

attachment objectrequired

Attachment file on the service request

file_datastringrequired

The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB.

Possible values: <= 16735272 characters

file_namestringrequired

The name of the file including the extension. Ex: "resume.pdf"

mime_typestringrequired

The mime type of the file. Ex: "application/pdf"

notesstring

General notes about the file

is_privateboolean

If the file should be marked as private

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired
integration_idstringrequired
The Propexo unique identifier for the integration
service_request_idstringrequired
The Propexo unique identifier for the service request
attachment objectrequired
file_datastring | nullnullable
The contents of the file, as a base64 encoded string. The PMS has a max file size of 12 MB.
Possible values: <= 16735272 characters
file_namestringrequired
The name of the file including the extension. Ex: "resume.pdf"
mime_typestringrequired
The mime type of the file. Ex: "application/pdf"
notesstring | nullnullablerequired
is_privateboolean | nullnullablerequired

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

POST /v1/service-requests/propertyware/:service_request_id/file-upload/

curl -X POST https://api.propexo.com/v1/service-requests/propertyware/:service_request_id/file-upload/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string",
  "attachment": {
    "file_data": "string",
    "file_name": "string",
    "mime_type": "string"
  }
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "service_request_id": "string",
    "attachment": {
      "file_data": "string",
      "file_name": "string",
      "mime_type": "string"
    },
    "notes": "string",
    "is_private": true
  }
}