Residents

Create resident pet

Create a resident pet for an integration.

post/v1/resident-pets/

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/resident-pets/
  • Auth: HTTP bearer

Request body

integration_idstring required
resident_idstring

The Propexo unique identifier for the resident

is_service_animalboolean

Whether the resident pet is a service animal. This field requires your customer uses Plug-in 17+ in Yardi Voyager.

age_in_yearsinteger

The age in years of the resident pet

colorstring

The color of the resident pet

gender_rawstring

The raw value for the gender of the resident pet

is_fixedboolean

Whether the resident pet is fixed

namestring

The name associated with the resident pet

typestring

The type associated with the resident pet

weight_in_poundsinteger

The weight in pounds of the resident pet

breedstring

The breed of the resident pet

notesstring

Notes associated with the resident pet

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1ResidentPetsPostOutputData required

Changes

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