ItemProperties

Changes a property's name, data type or options.

Requires ManageTemplates and an Idempotency-Key header — in the app a property's definition is edited on the Item Templates page. Only the fields sent change, all in one save (every field is validated first). Rules as on that page: names are unique on the item; changing dataType clears the value unless the new type is Text and is refused while the property has an enabled calculation. Additionally: options are allowed only for Dropdown / MultiSelect and dropped when the type leaves them; Cost / Unit Price cannot be changed and are reserved names. Inventory units keep their copies under the old name / type (as with the page). Example: { "dataType": "Dropdown", "options": ["Red", "Blue"] }.

patch/api/v1/items/{id}/properties/{propertyId}

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/items/{id}/properties/{propertyId}
  • Auth: HTTP bearer

Path parameters

idinteger required

Numeric item id.

propertyIdinteger required

Property id from GET.

Request body

namestring nullable

New name, 1-100 characters, unique on the item (case-insensitive); Cost / Unit Price are reserved.

dataType'Text' | 'Number' | 'Date' | 'Boolean' | 'Dropdown' | 'MultiSelect'
optionsstring[] nullable

Full replacement option list for a Dropdown / MultiSelect property (at most 200 options, each 1-200 characters, no commas, no duplicates); [] clears it. Existing values are not re-checked.

Response

Changed; body is the item's properties.

itemIdinteger

The item (template) id, e.g. 12.

propagatedinteger

Writes only (0 on GET): how many inventory units' copies of the property were changed by the write (a new value flowing to units that were not individually customized, a new item-level property added to existing units, or the copies removed with a deleted one).

Changes

No recorded changes to this operation across all 1 revision of this API.