GEgetmaintainx
Custom Fields

Edit custom field

Changed on
patch/customfields/{entity}/{id}

Request

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

Path parameters

idinteger required

ID of the custom field

entity'assets' | 'locations' | 'parts' | 'workOrders' | 'vendors' | 'purchaseOrders' | 'lineItemPurchaseOrders' required

Type of entity

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

Example request

{
  "field": {
    "label": "Date Purchased"
  }
}

Response

Successfully edited the custom field

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 new optional request property /

    • info

      added the new enum value lineItemPurchaseOrders to the path request parameter entity

    • info

      added the new enum value purchaseOrders to the path request parameter entity

    • info

      added the new link enum value to the request property /

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status