Update Applicant: Yardi

PUThttps://api.propexo.com/v1/applicants/yardi/:applicant_id

Interface	Method
ILS Guest Card	ImportYardiGuest_Login

Authentication

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

Path parameters

applicant_id stringrequired

The Propexo unique identifier for the applicant

Request

This endpoint expects an object.

unit_idstring

The Propexo unique identifier for the unit

first_namestring

The first name associated with the applicant

last_namestring

The last name associated with the applicant

phone_1string

Primary phone number associated with the applicant

phone_1_typestring
Type of the primary phone number
Show 4 enum values
FAXHOMEMOBILEWORK
phone_2string

Secondary phone number associated with the applicant

phone_2_typestring
Type of the secondary phone number
Show 5 enum values
FAXHOMEMOBILEOTHERWORK
email_1string

The primary email address associated with the applicant

address_1string

The first address line associated with the applicant

address_2string

The second address line associated with the applicant

citystring

The city associated with the applicant

statestring

The state associated with the applicant

zipstring

The zip code associated with the applicant

countrystring

The country associated with the applicant

notesstring

Notes associated with the applicant

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired

applicant_idstringrequired

The Propexo unique identifier for the applicant

unit_idstring

The Propexo unique identifier for the unit

first_namestring

The first name associated with the applicant

last_namestring

The last name associated with the applicant

phone_1string

Primary phone number associated with the applicant

phone_1_typestring

Type of the primary phone number

Show 4 enum values

FAXHOMEMOBILEWORK

phone_2string

Secondary phone number associated with the applicant

phone_2_typestring

Type of the secondary phone number

Show 5 enum values

FAXHOMEMOBILEOTHERWORK

email_1string

The primary email address associated with the applicant

address_1string

The first address line associated with the applicant

address_2string

The second address line associated with the applicant

citystring

The city associated with the applicant

statestring

The state associated with the applicant

zipstring

The zip code associated with the applicant

countrystring

The country associated with the applicant

notesstring

Notes associated with the applicant

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

PUT /v1/applicants/yardi/:applicant_id

curl -X PUT https://api.propexo.com/v1/applicants/yardi/:applicant_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "unit_id": "string",
  "first_name": "string",
  "last_name": "string",
  "phone_1": "string",
  "phone_1_type": "FAX",
  "phone_2": "string",
  "phone_2_type": "FAX",
  "email_1": "string",
  "address_1": "string",
  "address_2": "string",
  "city": "string",
  "state": "string",
  "zip": "string",
  "country": "string",
  "notes": "string"
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "applicant_id": "string",
    "unit_id": "string",
    "first_name": "string",
    "last_name": "string",
    "phone_1": "string",
    "phone_1_type": "FAX",
    "phone_2": "string",
    "phone_2_type": "FAX",
    "email_1": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "string",
    "notes": "string"
  }
}