PUT
Rename a product option
Company space For: Manager · Permission: options.update Conditions
  • The new name must stay unique among the organization’s options.
  • The values field is refused on update; values are managed through the option values routes.
What else happens
  • The name is stored in lower case.
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).

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, name, 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: values.

Response

Resource (only with response=resource).

id

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

name

Name of the option, for example size or colour; stored in lower case.

values
array

Values of the option. Only returned when selected with ?include=values.

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.