Application vehicles

Add a vehicle

Records a vehicle the applicant will keep at the property and returns the new entry. Requires the rental_applications:write permission.

POST

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

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.

carMakestring

Manufacturer, for example "Toyota". At most 250 characters.

modelstring

Model name. At most 250 characters.

yearinteger

Model year.

licensePlatestring

Registration plate. At most 50 characters.

stateRegistrationstring

State or region the vehicle is registered in. At most 100 characters.

colorstring

Colour. At most 100 characters.

commentstring

Free-text note. At most 500 characters.

Response

200 · The new vehicle entry.

idstring

The vehicle entry.

carMakestring

Manufacturer, for example "Toyota".

modelstring

Model name.

yearinteger

Model year.

licensePlatestring

Registration plate.

stateRegistrationstring

State or region the vehicle is registered in.

colorstring

Colour.

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.