Appointments

Create Appointment

Create an appointment for an integration.

post/crm/v1/appointments

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/crm/v1/appointments
  • Auth: HTTP bearer

Request body

integration_idstring required
community_idstring

The Propexo unique identifier for the community

prospect_idstring

The Propexo unique identifier for the prospect. When provided, books an appointment for an existing prospect. When omitted, creates a new prospect with an appointment.

appointment_timestring

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

email_1string

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

phone_1string

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

first_namestring

The first name associated with the prospect

last_namestring

The last name associated with the prospect

rent_minimum_in_centsinteger

The minimum rent of the prospect

rent_maximum_in_centsinteger

The maximum rent of the prospect

notesstring

Notes associated with the prospect

desired_num_bedroomsinteger[]

The number of bedrooms associated with the prospect. 0 represents a studio unit. 3 represents three or more bedrooms.

tour_type'LIVE_VIDEO' | 'IN_PERSON' | 'SELF_GUIDED'

The type of appointment being scheduled.

lease_term_in_monthsinteger

The amount of months for the lease term

phone_2string

Primary phone number associated with the prospect

attribution_idstring

The Propexo unique identifier for the attribution

number_of_occupantsinteger

The number of occupants living in the unit

petsCrmV1AppointmentsPostInputPetsItems[]

A list of pets related to the prospect

first_contact_type'CALL' | 'CHAT' | 'EMAIL' | 'FACEBOOK' | 'FORM' | 'INTERNET' | 'KNOCK_SCHEDULE' | 'SMS' | 'WALK_IN'

The type of initial contact with the prospect

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataCrmV1AppointmentsPostOutputData required

Changes

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