GEgetmaintainx
Custom Fields

Create custom field

Changed on
post/customfields/{entity}

Request

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

Path parameters

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

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

Example request

{
  "fields": [
    {
      "label": "Date Purchased"
    }
  ]
}

Response

Successfully created the custom fields

idnumber required

ID of the custom field

labelstring required

The label of the custom field

sortOrderinteger required

The order which the field will be displayed in the UI

type'oneline' | 'multiline' | 'number' | 'singleSelect' | 'date' | 'datetime' | 'link' required
optionsstring[]

The possible choices to the field (if applicable).

Example response

[
  {
    "id": 1,
    "label": "Date Purchased",
    "sortOrder": 25
  }
]

Changes

  • 222e6fad7c1fRevision changes
    • breaking

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

    • warning

      added the new link enum value to the / response property for the response status

    • 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 //

    • 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