Skip to main content
PATCH
/
custom_field_definitions
/
{definition_id}
/
options
/
{option_id}
Update a custom field option
curl --request PATCH \
  --url https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options/{option_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "custom_field_option",
    "attributes": {
      "label": "<string>",
      "position": 123
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "custom_field_option",
    "attributes": {
      "label": "<string>",
      "value": "<string>",
      "position": 123
    }
  },
  "links": {
    "self": "<string>"
  }
}
Update an existing custom field option.

​
Path parameters

ParameterDescription
definition_idThe unique identifier of the custom field definition
option_idThe unique identifier of the option

​
Request body

Provide the fields you want to update, such as label or position.

Authorizations

​
Authorization
string
header
required

Token YOUR_API_TOKEN

The APIs require authentication to be done using header-based API Key and Secret Authentication.

API key and secret are sent va the Authorization request header.

You send your API key and secret in the following way:

Authorization: Token YOUR_API_KEY

Path Parameters

​
definition_id
string
required

Custom field definition ID

​
option_id
string
required

Custom field option ID

Body

application/json
​
data
object

Response

200 - application/json

OK

​
data
Custom field option · object
​
links
link · object