Update resident
Update a resident for an integration.
Request
- Base URL: https://api.propexo.com
- URL: https://api.propexo.com/v1/residents/{id}
- Auth: HTTP bearer
Path parameters
The ID of the resource.
Request body
The Propexo unique identifier for the resident
The last name of the resident.
The first name of the resident.
The primary email address for the resident.
The secondary email address associated with the resident
The first address line associated with the resident
The second address line associated with the resident
The city associated with the resident
The state associated with the resident
The zip code associated with the resident
The country associated with the resident
Secondary/alternate street address for the resident. This maps to the Street property of the second address of the Tenant object
Second line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine2 property of the Tenant object
City of the resident's secondary/alternate address
State of the resident's secondary/alternate address
Zip/Postal Code of the resident's secondary/alternate address
Country of the resident's secondary/alternate address.
Notes associated with the resident
The primary phone number for the resident.
The primary phone type for the resident. Required when updating phone number.
Secondary phone number associated with the resident
Type of the secondary phone number
Deprecated: Field is no longer applicable
The middle name associated with the resident
The Propexo unique identifier for the lead source
The middle initial of the resident
Whether the resident is qualified
The gender of the resident
Indicates if the resident is a guarantor for the primary resident.
The monthly income of the resident, in cents
To restrict the resident from making payments by check, set this to true. Defaults to false.
How often the resident is expected to pay rent. Allowed values are "monthly", "weekly", and "daily". Maps to the RentPeriod property of the Tenant object.
Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object
Whether the resident is the primary record
Response
Successful response
The ID of the job created to handle this operation
Changes
No recorded changes to this operation across all 1 revision of this API.