Automated SFTP File Upload via API or Website

If your company doesn't have a property management system that Flamingo integrates with, you can upload your resident data manually on the Flamingo interface or you can set up an automated SFTP upload using one of the two options below. We recommend daily upload.

Option 1: STFP Website Upload

You can set up a script to automatically upload the file daily to the URL below. Flamingo will provide you with a user name and password that corresponds with each building. This method accommodates 1 file per building. The username and password is unique to each building.

Sandbox SFTP Website URL: https://uat-startupsoft-hellohealthy.azurewebsites.net/SFTPIntegration

Production SFTP Website URL: https://dashboard.getflamingo.com/SFTPIntegration

User Name: [provided by Flamingo]
Password: [provided by Flamingo]

Option 2: Send file via API.

Flamingo will provide you with a BuildingID that needs to be appended at to the URL below where it says "Production SFTP Website URL." This method accommodates 1 file per building. The Building is unique to each building.

Production Request URL: https://prod-hellohealthy-api.azurewebsites.net/api/v3.0/PMS/UploadSFTPFile/ADD_BUILDING_ID_HERE

One file per building. You’ll be provided with the Building ID of each building.

Production Request URL Example: https://prod-hellohealthy-api.azurewebsites.net/api/v3.0/PMS/UploadSFTPFile/615eec287a35c72684667788

Request Method: POST

Payload: Form Data

Key: file

Value: YOUR_FILE

Success:

Code: 200

Sample Response:

{

"fileName": "249a07709c684ad.xlsx",

"filePath": "https://devhellohealthy.blob.core.windows.net/files/sftp/97c5f9daed0737a.xlsx ",

"isUploaded": true

}

Possible Errors

1. If file is not passed or empty

Code: 400

Message: Please select the file

2. If the Building is not found with Given Building Id

Code: 400

Message: Building not found

3. If SFTP is not enabled for the Building

Code : 422

Message : Unable to process your request, please contact admin (support@getflamingo.com)

4. Fail to upload file

Code : 500

Message : Unable to upload the file

5. General error

Code : 500

Message : Unable to upload the file

The SFTP file must contain the following fields: The ones in blue are required

FirstName

LastName

PhoneNumber

Birthday

MovedIn

MovedOut

LeaseStart

LeaseExpires

PMSStatus

UnitNumber

CustomerType

CustomStatus

You can use one of the following phone formats for SFTP file: No characters, just numerics

e.g. 5555555555

You can use one of the following date formats for SFTP file:

1. MM/dd/yy

2. MM/dd/yyyy

3. M/d/yyyy

4. MM-dd-yy

5. MM-dd-yyyy

You can any of the following for "PMSStatus" for SFTP file to designate their property management system resident status:

Future
Current
Notice
Eviction
Former
Past

You must use one of the following for "CustomerType" to designate the primary lease holder or keep blank:

Primary

You can use any of the following for "CustomStatus" or keep blank:

Amenity Fee Member

Your file type must be one of the following:

.CSV
.XLS
.XLSX

Recommended Name Convention: Buillding Name_Date
Example: Nightingale Apartments - 12/1/2023

Sample file: Sample Flamingo SFTP File

Sample file: See image below

Did this answer your question?

😞 😐 😃

Flamingo Support

Automated SFTP File Upload via API or Website