PUT
Edit an option value
Company space For: Manager · Permission: option_values.update Conditions
  • The new value is required, at most 255 characters, and must stay unique within the option (the value’s own text does not conflict).
Part of Organize with options and categories.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

option
string
required

Identifier of the product option (27-character KSUID string).

value
string
required

Identifier of the option value, which must belong to the option in the URL.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, option_id, value, created_at, updated_at, organization_id.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Body

application/json
value
string
required

Text of the value. Required, at most 255 characters; trimmed and converted to lower case before validation; must be unique within the option.

Maximum string length: 255

Response

Resource (only with response=resource).

id

Identifier of the option value (27-character KSUID string).

option_id

Identifier of the option the value belongs to.

value

Text of the value, for example large; stored trimmed and in lower case.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).

organization_id

Identifier of the organization the record belongs to.