ItemProperties

Replaces one custom-field value.

Requires ManageInventory and an Idempotency-Key header. Single-property form of PATCH /api/v1/items/{id}/properties with the same rules (Customized flag, flow to inventory units, dependent calculated values recomputed, typed validation, calculated and pricing properties refused). Example: { "value": "Red" }.

put/api/v1/items/{id}/properties/{propertyId}/value

Request

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

Path parameters

idinteger required

Numeric item id.

propertyIdinteger required

Property id from GET.

Request body

valuestring nullable

New value, at most 4000 characters, in the property's format (see value on GET); "" or null clears it.

Response

Value saved; body is the item's properties, propagated = inventory unit copies updated.

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.