Custom views

Create a custom view

Saves a new column layout for one list screen. The key is generated from the name, and a name that produces a key the company already uses is rejected. Requires the settings:write permission.

POST

https://services.magicdoor.com/settings/company-portal/settings/custom-views/{type}

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

typeenum<string>required

Which list screen the view belongs to. Matched case-insensitively, and echoed back in viewType exactly as spelled here.

example: LeasesUnitsPropertiesLeasesLeasesWithBalanceDueDraftLeasesExpiringLeasesPastLeasesLeasesWithMoveOutRequestsLeaseRentalApplicationsPropertyApplicationsAccountingBillsMaintenanceRequestsWorkOrdersWorkOrderBillsPropertyManagersOwnersTenants

Body

application/json

namestringrequired

What to call the view. Between 3 and 50 characters, and it cannot be Default in any casing — that name is reserved for the built-in view. The key is regenerated from this name.

favoriteboolean

Make this the view the screen opens with. Setting it clears the flag on every other view of the same type.

default: false

descriptionstring

Free text about the view.

columnsobject[]required

The columns the view shows. May be empty. When it is not empty every entry must have selected set to true and a displayOrder, and those orders must be the whole numbers 1 to N with no gaps and no repeats.

Response

200 · The saved view, with the key that was generated for it.

idstringrequired

The view's Snowflake id, as a decimal string. The built-in default view returns the literal string default instead.

keystringrequired

The view's key, derived from its name and used to address it in the other endpoints.

namestringrequired

What the view is called on screen.

viewTypeenum<string>required

The list screen this view belongs to, capitalised.

UnitsPropertiesLeasesLeasesWithBalanceDueDraftLeasesExpiringLeasesPastLeasesLeasesWithMoveOutRequestsLeaseRentalApplicationsPropertyApplicationsAccountingBillsMaintenanceRequestsWorkOrdersWorkOrderBillsPropertyManagersOwnersTenants

favoritebooleanrequired

Whether this is the view the screen opens with. At most one view per type can be the favorite.

descriptionstring

Free text the property manager wrote about the view. Absent when none was given.

columnsobject[]required

The view's columns.

400 · The name is missing, shorter than 3 or longer than 50 characters, or is `Default`; or the columns are not all selected, not all numbered, or not numbered 1 to N without gaps or repeats.