Application pets

Add a pet

Records a pet the applicant will bring to the property and returns the new entry. Requires the rental_applications:write permission.

POST

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

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

Body

application/json

Every field is optional.

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 new 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 rental application with this id exists, or it belongs to another company. Both cases look identical so that ids cannot be probed across companies.

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.

Service and support animals are recorded, not enforced

isServiceAnimal and isEmotionalSupportAnimal are what the applicant declared. MagicDoor does not verify them and does not apply any pet policy on the basis of them.