GEgetmaintainx
Categories

Update category

Changed on
patch/categories/{id}

Request

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

Path parameters

idinteger required

ID of the category

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

Request body

labelstring

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 edited category

Example response

{
  "category": {
    "id": 963,
    "label": "Safety",
    "description": "Used for everything related to Safety",
    "workOrderCount": 3,
    "updatedAt": "2022-01-01T00:00:00.000Z"
  }
}

Changes

  • 222e6fad7c1fRevision changes
    • breaking

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

    • info

      added the new optional query request parameter skipWebhook

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status