Create Applicant Files: Entrata

POSThttps://api.propexo.com/v1/applicants/entrata/:applicant_id/file-upload

Method
leases/sendLeaseDocuments

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

applicant_id stringrequired

The Propexo unique identifier for the applicant

Request

This endpoint expects an object.

integration_idstringrequired

The Propexo unique identifier for the integration

application_idstringrequired

The Propexo unique identifier for the application

attachments object[]required
Files to upload for the applicant. All the files can have a maximum combined file size of 50 MB
Array [
file_datastringrequired
The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB.
Possible values: <= 69730304 characters
file_namestringrequired
The name of the file including the extension. Ex: "image.jpg"
mime_typestringrequired
The mime type of the file. Ex: "image/jpeg"
file_type_idstringrequired
The Propexo file type ID of the file type to upload
is_privateboolean
If the file should be marked as private. If true the file will not be shown in the resident portal.
]

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired
integration_idstringrequired
The Propexo unique identifier for the integration
applicant_idstringrequired
The Propexo unique identifier for the applicant
application_idstringrequired
The Propexo unique identifier for the application
attachments object[]required
Array [
file_datastring | nullnullable
The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB.
Possible values: <= 69730304 characters
file_namestringrequired
The name of the file including the extension. Ex: "image.jpg"
mime_typestringrequired
The mime type of the file. Ex: "image/jpeg"
file_type_idstringrequired
The Propexo file type ID of the file type to upload
is_privateboolean
]

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/applicants/entrata/:applicant_id/file-upload

curl -X POST https://api.propexo.com/v1/applicants/entrata/:applicant_id/file-upload \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string",
  "application_id": "string",
  "attachments": [
    {
      "file_data": "string",
      "file_name": "string",
      "mime_type": "string",
      "file_type_id": "string",
      "is_private": true
    }
  ]
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "applicant_id": "string",
    "application_id": "string",
    "attachments": [
      {
        "file_data": "string",
        "file_name": "string",
        "mime_type": "string",
        "file_type_id": "string",
        "is_private": true
      }
    ]
  }
}