Residents

Update resident

Update a resident for an integration.

put/v1/residents/{id}

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/residents/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The ID of the resource.

Request body

resident_idstring

The Propexo unique identifier for the resident

last_namestring

The last name of the resident.

first_namestring

The first name of the resident.

email_1string email

The primary email address for the resident.

email_2string email

The secondary email address associated with the resident

address_1string

The first address line associated with the resident

address_2string

The second address line associated with the resident

citystring

The city associated with the resident

state'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT' | 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'AA' | 'AE' | 'AP' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UM' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY'

The state associated with the resident

zipstring

The zip code associated with the resident

country'US' | 'CA'

The country associated with the resident

address_1_alternatestring

Secondary/alternate street address for the resident. This maps to the Street property of the second address of the Tenant object

address_2_alternatestring

Second line of the secondary/alternate street address for the resident. This maps to the AlternateAddress.AddressLine2 property of the Tenant object

city_alternatestring

City of the resident's secondary/alternate address

state_alternatestring

State of the resident's secondary/alternate address

zip_alternatestring

Zip/Postal Code of the resident's secondary/alternate address

country_alternate'US'

Country of the resident's secondary/alternate address.

notesstring

Notes associated with the resident

phone_1string

The primary phone number for the resident.

phone_1_type'HOME' | 'WORK' | 'MOBILE' | 'FAX'

The primary phone type for the resident. Required when updating phone number.

phone_2string

Secondary phone number associated with the resident

phone_2_type'FAX' | 'HOME' | 'MOBILE' | 'OTHER' | 'WORK'

Type of the secondary phone number

custom_dataV1ResidentsIdPutInputCustomData

Deprecated: Field is no longer applicable

middle_namestring

The middle name associated with the resident

lead_source_idstring

The Propexo unique identifier for the lead source

middle_initialstring

The middle initial of the resident

qualifiedboolean

Whether the resident is qualified

gender'MALE' | 'FEMALE'

The gender of the resident

guarantorboolean

Indicates if the resident is a guarantor for the primary resident.

monthly_income_in_centsinteger

The monthly income of the resident, in cents

no_checks_in_cash_receiptsboolean

To restrict the resident from making payments by check, set this to true. Defaults to false.

rent_period'MONTHLY' | 'WEEKLY' | 'DAILY'

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.

rent_due_dayinteger

Day of the month on which the tenant's rent is due. Maps to the RentDueDay property of the Tenant object

is_primaryboolean

Whether the resident is the primary record

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1ResidentsIdPutOutputData required

Changes

No recorded changes to this operation across all 1 revision of this API.