API ReferenceResidents

Create resident pet

Create a resident pet for an integration.

Headers

AuthorizationstringRequired

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_animalbooleanOptionalDefaults to false
Whether the resident pet is a service animal
age_in_yearsintegerOptional>=0
The age in years of the resident pet
colorstringOptional
The color of the resident pet
gender_rawstringOptional
The raw value for the gender of the resident pet
is_fixedbooleanOptionalDefaults to false
Whether the resident pet is fixed
namestringOptional
The name associated with the resident pet
typestringOptional
The type associated with the resident pet
weight_in_poundsintegerOptional>=0
The weight in pounds of the resident pet

Response

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

Errors