Create Resident Pet: Yardi

POST

/v1/resident-pets/yardi/

Create a resident pet in Yardi.

Interface	Method
Common Data	UpdateResidentData

Notice

This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.

Create a resident pet in Yardi. | Interface | Method | |---|---| | Common Data | UpdateResidentData | <Note title="Notice">This write operation will set the created_record_id flag on the write-status endpoint and allow for new record to be read back in immediately.</Note>

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

integration_idstringRequired

The Propexo unique identifier for the integration

resident_idstringRequired

The Propexo unique identifier for the resident

typestringRequired<=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

$	curl -X POST https://api.propexo.com/v1/resident-pets/yardi/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"integration_id": "string",
>	"resident_id": "string",
>	"type": "string"
>	}'

1	{
2	"meta": {
3	"job_id": "string"
4	},
5	"result": {
6	"integration_id": "string",
7	"resident_id": "string",
8	"type": "string",
9	"age_in_years": 1,
10	"breed": "string",
11	"color": "string",
12	"gender_raw": "string",
13	"is_fixed": true,
14	"is_service_animal": true,
15	"name": "string",
16	"weight_in_pounds": 1
17	}
18	}