{
  "job_id": "string",
  "data": {}
}

​
Body

integration_idrequired
string
type
string

The lease type. The value of this field must be one of "Fixed", "FixedWithRollover", or "AtWill"

Available options:
Fixed,
FixedWithRollover,
AtWill
x_unit_id
string

The external ID of the unit from the integration vendor

start_date
string

The date that the lease begins

end_date
string

The date that the lease ends

send_welcome_email
Default: false
boolean

A boolean value indicating whether or not to send a welcome email to the tenant

first_name
string

The first name of the primary resident on this lease.

last_name
string

The last name of the primary resident on this lease.

email_1
string

The email address for the primary resident on this lease.

email_2
string

The secondary/alternate email address for the primary resident on this lease. This value maps to the AlternateEmail property of the Tenant object

phone_1
string

The phone number of the primary resident on this lease.

phone_1_type
string

The type of the primary resident's phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'.

Available options:
HOME,
WORK,
MOBILE,
FAX
phone_2
string

The second phone number of the primary resident on this lease.

phone_2_type
string

The type of the primary resident's secondary phone number. The value passed in here must be one of 'HOME', 'WORK', 'MOBILE', FAX'.

Available options:
HOME,
WORK,
MOBILE,
FAX
date_of_birth
string

The date of birth for the primary resident on this lease.

address_1
string

The first line of the primary resident's address.

address_2
string

The second line of the primary resident's address.

city
string

The city of the primary resident's address.

state
string

The state of the primary resident's address.

zip
string

The postal code of the primary resident's address.

country
string

Country of the resident's primary address. This maps to the Address.Country property of the Tenant object.

Available options:
US
address_1_alternate
string

First line of the street address for the primary resident. This maps to the Address.AddressLine1 property of the primary address of the Tenant object

address_2_alternate
string

Second line of the street address for the primary resident. This maps to the Address.AddressLine2 property of the Tenant object.

city_alternate
string

City of the primary resident's address. This maps to the Address.City property of the Tenant object.

state_alternate
string

State of the primary resident's address. This maps to the Address.State property of the Tenant object.

zip_alternate
string

Zip/Postal Code of the primary resident's address. This maps to the Address.PostalCode property of the Tenant object.

country_alternate
string

Country of the resident's primary address. This maps to the Address.Country property of the Tenant object.

rent_cycle
string

How often rent charges will be automatically appended to the lease ledger. Must be one of 'Monthly', 'Weekly', 'Every2Weeks', 'Quarterly', 'Yearly', 'Every2Months', 'Daily', 'Every6Months', 'OneTime',

Available options:
Monthly,
Weekly,
Every2Weeks,
Quarterly,
Yearly,
Every2Months,
Daily,
Every6Months,
OneTime
rent_amount_in_cents
integer

The amount of rent to be appended to the lease ledger, in cents

rent_due_date
string

The next date on which rent is due. If a rent cycle other than "OneTime" is provided, this will also be the date on which that cycle begins. Expected format is YYYY/MM/DD

gl_account_id
string

The general ledger account under which to record the rent charge

property_id
string

The Propify unique identifier for the property

unit_id
string

The Propify unique identifier for the unit

floor_plan_id
string

The floor plan id for the lease.

scheduled_move_in_date
string

The move in date

lease_term_in_months
integer

The amount of months for the lease term.

Available options:
3,
6,
9,
12,
15,
18
x_property_id
string

The external ID of the property from the integration vendor This field is not required, and the Unit ID provided in x_unit_id takes precedence.

x_resident_id
string

The external ID of the resident from the integration vendor

scheduled_move_out_date
string

The move out date

realized_move_in_date
string

The date that the resident moved in

realized_move_out_date
string

The date that the resident moved out

primary_contact_id
string

The Propify unique identifier of the primary contact. This must either be a lead, applicant or resident in Propify

tenants
array

An array of Propify lead, applicant, or resident IDs. This must also include the primary contact ID

status
string

The status of the lease

Available options:
Draft,
Active,
Active - Notice Given,
Terminated,
Eviction

​
Response

job_idrequired
string

The ID of the job created to handle this operation

datarequired
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.