Unit listings

Create listings for units in bulk

Creates a listing for every active unit matched by the portfolios, properties or units you name. Units that already have one are left as they are.

POST

https://api.portal.magicdoor.com/company-app/unit-listings/import

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.

Body

application/json

Give at least one of the three lists. They combine as a single filter over units.

portfolioIdsstring[]

Create listings for every active unit in these portfolios.

propertyIdsstring[]

Create listings for every active unit on these properties.

unitIdsstring[]

Create listings for these units.

Response

200 · The listings that now exist for the matched units.

unitListingIdsstring[]

Ids of the listings, which are the unit ids they belong to.

400 · All three lists were empty or missing, or one of the ids is not a decimal 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.

Only active units are touched

Whatever you pass, MagicDoor narrows the match to units that are active and belong to your company before it creates anything.

Request

curl --request POST \
  --url 'https://api.portal.magicdoor.com/company-app/unit-listings/import' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "propertyIds": [
    "1830472847398404097"
  ]
}'

Body

{
  "propertyIds": [
    "1830472847398404097"
  ]
}

Response

{
  "unitListingIds": [
    "1830472847398404098",
    "1830472847398404133"
  ]
}