Vendor categories

Create a vendor category

Creates a vendor category for the company and returns it. Requires the vendor_categories:write permission.

POST

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

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

namestringrequired

The category name shown to staff, for example "Electrical". Between 1 and 150 characters, and it must not match a category the company already has.

Response

200 · The category that was created.

idstringrequired

The new 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.

409 · The company already has a category with that name.

Request

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

Body

{
  "name": "Electrical"
}

Response

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