Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Custom Fields

Create custom field

post/customfields/{entity}

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
  }
]