Lease template categories

Rename a lease template category

Changes a category's name. The templates in it stay where they are.

PUT

https://api.portal.magicdoor.com/company-app/lease-templates/categories/{leaseTemplateCategoryId}

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

leaseTemplateCategoryIdstringrequired

The category to rename. A Snowflake id, sent as a decimal string.

example: 1844019384756201984

Body

application/json

namestringrequired

New category name. Up to 150 characters.

Response

200 · The renamed category.

idstring

Id of the category. A Snowflake id, sent as a decimal string.

namestring

Category name. 1 to 150 characters.

isDefaultboolean

True for MagicDoor's built-in categories, false for ones the company added.

400 · The request failed validation. `errors` maps each field name to what was wrong with it.

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

404 · No lease template category matched the id, or it belongs to another company.

Request

curl --request PUT \
  --url 'https://api.portal.magicdoor.com/company-app/lease-templates/categories/1844019384756201984' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Residential leases (Oregon)"
}'

Body

{
  "name": "Residential leases (Oregon)"
}

Response

{
  "id": "1844019384756201984",
  "name": "Residential leases (Oregon)",
  "isDefault": false
}