Categories

Replaces one or more existing categories

Changed on

Every field of each category is replaced with the value in the body: key, name, imageUrl and properties. A field that is left out is cleared. For example, a body without imageUrl removes the category's image, and a body without properties removes every translated field of the category.

id, key and name are required. icon is ignored.

To change one field, read the category with GET /{apiKey}/api/categories, change only that field, and send the whole category back.

Oauth2 Roles

  • Requires user to have one of the following roles: admin, editor, owner, service
put/{apiKey}/api/categories

Request

  • Base URL
    https://integration.mapsindoors.com (the document declares no server; this is the origin it was published from)
  • URL
    https://integration.mapsindoors.com/{apiKey}/api/categories
  • Auth
    OAuth 2
    Authorization code: https://auth.mapsindoors.com/connect/authorize
    Token URL: https://auth.mapsindoors.com/connect/token scopes: integration

Path parameters

apiKeystring required

The API Key to use

Request body

idstring nullable
keystring nullable
nameobject nullable
iconstring nullable
imageUrlstring nullable
propertiesobject nullable

Response

OK

Changes

    • info

      the security scope integration was added to the endpoint's security scheme account

    • info

      the security scope account was removed from the endpoint's security scheme account

    • info

      added the non-success response with the status