Categories

Create new category

Changed on
post/categories

Request

  • Base URL
    https://api.getmaintainx.com/v1
  • Auth
    HTTP bearer

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

labelstring required

Label used when displaying the category.

descriptionstring

Description field for additional information.

Example request

{
  "label": "Safety",
  "description": "Used for everything related to Safety"
}

Response

Successfully created category

idinteger required

Global ID of the category.

Example response

{
  "id": 963
}

Changes

    • breaking

      removed the media type application/octet-stream from the request body

    • info

      added the new optional header request parameter x-organization-id

    • info

      added the new optional query request parameter skipWebhook

    • info

      added the new optional request property