PMS Generic APIsResidents

Create resident pet

Create a resident pet for an integration.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
integration_idstringRequired
resident_idstringOptional
The Propexo unique identifier for the resident
is_service_animalbooleanOptional

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

age_in_yearsintegerOptional>=0
The age in years of the resident pet
colorstringOptional<=40 characters
The color of the resident pet
gender_rawstringOptional<=40 characters
The raw value for the gender of the resident pet
is_fixedbooleanOptional
Whether the resident pet is fixed
namestringOptional<=40 characters
The name associated with the resident pet
typestringOptional<=40 characters
The type associated with the resident pet
weight_in_poundsintegerOptional>=0
The weight in pounds of the resident pet
breedstringOptional<=1000 characters
The breed of the resident pet
notesstringOptional
Notes associated with the resident pet

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors

400
Bad Request Error