Application pets

Update a pet

Replaces a pet entry with the values you send and returns it. Every field is overwritten, so anything you leave out is cleared. Requires the rental_applications:write permission.

PUT

https://services.magicdoor.com/leasing/company-portal/rental-applications/{applicationId}/pets/{id}

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

applicationIdstringrequired

The rental application to work with. A Snowflake id, sent as a decimal string.

example: 1830472847398404096

idstringrequired

The pet entry to work with. A Snowflake id, sent as a decimal string.

example: 1832847391028374528

Body

application/json

Send the entry in full — this is a replace, not a merge.

namestring

The pet's name. At most 250 characters.

breedstring

Breed. At most 250 characters.

weightstring

Weight as free text, for example "28 lb". At most 100 characters — this is a string, not a number.

ageinteger

Age in years.

genderenum<string>

The pet's sex.

malefemale

isSpayedOrNeuteredboolean

Whether the pet is spayed or neutered.

isServiceAnimalboolean

Whether the applicant declares the animal a service animal.

isEmotionalSupportAnimalboolean

Whether the applicant declares the animal an emotional-support animal.

commentstring

Free-text note. At most 500 characters.

Response

200 · The updated pet entry.

idstring

The pet entry.

namestring

The pet's name.

breedstring

Breed, as the applicant described it.

weightstring

Weight as free text, for example "45 lb" — this is not a number.

ageinteger

Age in years.

genderenum<string>

The pet's sex.

malefemale

isSpayedOrNeuteredboolean

Whether the pet is spayed or neutered.

isServiceAnimalboolean

Whether the applicant declared the animal a service animal.

isEmotionalSupportAnimalboolean

Whether the applicant declared the animal an emotional-support animal.

commentstring

Free-text note stored with the entry.

createdstring · date-time

When the entry was added, in the company's timezone.

updatedstring · date-time

When the entry was last changed, in the company's timezone.

401 · The access token is missing, expired, or not valid.

403 · The caller is authenticated but does not hold the `rental_applications:write` permission.

404 · No pet entry with this id exists on this rental application, or the rental application itself was not found.

Allowed in every application status

This is not gated on the application's status — it works on a draft, on a submitted application, and on a retracted one. Only the applicant-facing portal locks an application once it is submitted.