Skip to main content
PATCH
/
api
/
v2
/
platform
/
option_values
/
{id}
Update an Option Value
curl --request PATCH \
  --url http://{defaultHost}/api/v2/platform/option_values/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "option_value": {
    "name": "red",
    "presentation": "Red",
    "public_metadata": {},
    "private_metadata": {}
  }
}
'
{
  "data": {
    "id": "75",
    "type": "option_value",
    "attributes": {
      "position": 1,
      "name": "M",
      "presentation": "S",
      "created_at": "2022-11-08T19:34:35.140Z",
      "updated_at": "2022-11-08T19:34:35.372Z",
      "public_metadata": {},
      "private_metadata": {}
    },
    "relationships": {
      "option_type": {
        "data": {
          "id": "86",
          "type": "option_type"
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes

Body

application/json
​
option_value
object
required

Response

Record updated

​
data
object
required