Skip to main content
PATCH
Update a product option

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

id
string
required

ProductOption identifier

Body

application/merge-patch+json

The updated ProductOption resource

name
string
product
string<iri-reference>
Example:

"/api/v1/products/1"

isArchived
boolean | null
position
integer | null

Response

ProductOption resource updated

id
integer
read-only
name
string
product
object
isArchived
boolean | null
position
integer | null