Update Resident Pet: Yardi

PUT

/v1/resident-pets/yardi/:pet_id

Update a resident pet in Yardi. All current pet fields are sent on update because Yardi deletes the pet if every field in the update is empty. Requires Common Data Plug-in 14+.

Interface	Method
Common Data	UpdateResidentData

Update a resident pet in Yardi. All current pet fields are sent on update because Yardi deletes the pet if every field in the update is empty. Requires Common Data Plug-in 14+. | Interface | Method | |---|---| | Common Data | UpdateResidentData |

Authentication

AuthorizationBearer

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

Path parameters

pet_idstringRequired

The Propexo unique identifier for the resident pet

Request

This endpoint expects an object.

typestringOptional<=40 characters

The type associated with the resident pet

age_in_yearsintegerOptional>=0

The age in years of the resident pet

breedstringOptional<=1000 characters

The breed 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

is_service_animalbooleanOptional

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

namestringOptional<=40 characters

The name associated with the resident pet

weight_in_poundsintegerOptional>=0

The weight in pounds of the resident pet

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error