Maintenance request categories

Update a maintenance request category

Replaces the name and description of a maintenance request category and returns it. Both values are written from the request body, so omitting description clears it. Requires the maintenance_request_categories:write permission.

PUT
https://services.magicdoor.com/maintenance/company-portal/maintenance-requests/categories/{maintenanceRequestCategoryId}

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

maintenanceRequestCategoryIdstringrequired

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

example: 1830472847398404096

Body

application/json

namestringrequired

The new category name. Between 1 and 150 characters.

descriptionstring

The new explanation, at most 2000 characters. Leave it out to clear the existing one.

Response

200 · The updated category.

idstringrequired

The category.

companyIdstringrequired

The company that owns the category.

namestringrequired

The category name.

descriptionstring

The explanation, absent when none is set.

createdstring · date-timerequired

When the category was created, in the company's timezone and without an offset.

updatedstring · date-timerequired

When the category was last changed, in the company's timezone and without an offset.

401 · The request carried no valid access token.

403 · The token is not a property manager token, or it lacks the `maintenance_request_categories:write` permission.

404 · No such category, or it belongs to another company.

409 · Another category in the company already has that name. Changing only the letter case of the current name is allowed.