MagicDoorAPI
SupportOpen MagicDoor
Unit listings

Invite someone to apply

Sends a named prospect an invitation to apply for this unit, by email or by text. One of the two contact details is required.

POST
https://api.portal.magicdoor.com/company-app/unit-listings/{unitId}/application-invite

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

unitIdstringrequired

Snowflake id of the unit. A unit listing has no id of its own — it is keyed by the unit it markets, so this is also the listing's id.

example: 1830472847398404098

Body

application/json

Give email, phone, or both — the call is rejected when neither is present.

namestringrequired

Who the invitation is addressed to. Must not be blank.

emailstring · email

Where to email the invitation. Required if phone is not given.

phonestring

Where to text the invitation. Required if email is not given.

Response

200 · The invitation was sent. The response has no body.

400 · `name` is blank, neither `email` nor `phone` was given, or one of them is not a valid address or number. The response carries an `errors` member mapping each rejected field name to its message.

401 · The access token is missing, expired, or not for this company.

404 · No listing for that unit, or it belongs to another company.