KnockAppointments

Create Appointment: Knock

Knock does not allow specifying appointment end times or durations via their API.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
integration_idstringRequired
The Propexo unique identifier for the integration
community_idstringRequired
The Propexo unique identifier for the community
attribution_idstringRequired
The Propexo unique identifier for the attribution
appointment_datestringRequired
The date when the appointment will occur
appointment_timestringRequiredformat: "(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)"
The time when the appointment will occur. Please refer to our appointment times section in the docs to see how each individual PMS handles timezones. This time should be specified in UTC
last_namestringRequired
The last name associated with the prospect
email_1stringOptional

The primary email address associated with the prospect. This field and/or the phone_1 field are required

phone_1stringOptionalformat: "^\+?\d{1,50}$"

Primary phone number associated with the prospect. This field and/or the email_1 field are required

first_namestringOptional
The first name associated with the prospect
move_in_datestringOptional

The move-in date associated with the prospect

number_of_occupantsintegerOptional
The number of occupants living in the unit
lease_term_in_monthsintegerOptional1-18
The amount of months for the lease term
rent_minimum_in_centsintegerOptional>=1
The minimum rent of the prospect
rent_maximum_in_centsintegerOptional>=1
The maximum rent of the prospect
notesstringOptional<=1000 characters
Notes associated with the prospect
desired_num_bedroomslist of integersOptional
The number of bedrooms associated with the prospect. 0 represents a studio unit. 3 represents three or more bedrooms.
petslist of enumsOptional
A list of pets related to the prospect
Allowed values:
first_contact_typeenumOptional
The type of initial contact with the prospect
tour_typeenumOptional
The type of appointment being scheduled.
Allowed values:

Response

Successful response
metaobject
resultobject

Errors