Vendor categories

Rename a vendor category

Changes the name of a vendor category and returns it. Name is the only thing a vendor category carries. Requires the vendor_categories:write permission.

PUT

https://services.magicdoor.com/maintenance/company-portal/vendors/categories/{vendorCategoryId}

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

vendorCategoryIdstringrequired

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

example: 1829110384726355968

Body

application/json

namestringrequired

The new category name. Between 1 and 150 characters.

Response

200 · The renamed category.

idstringrequired

The category.

namestringrequired

The category name.

401 · The request carried no valid access token.

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

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

409 · Another category in the company already has that name.

Request

curl --request PUT \
  --url 'https://services.magicdoor.com/maintenance/company-portal/vendors/categories/1829110384726355968' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Electrical and lighting"
}'

Body

{
  "name": "Electrical and lighting"
}

Response

{
  "id": "1829110384726355968",
  "name": "Electrical and lighting"
}