Update a custom field option

Update an enum option on a custom field definition in the Terminal49 API. Change the option’s display label without invalidating records that reference it.

PATCH /custom_field_definitions/{definition_id}/options/{option_id}

Update a custom field option

cURL

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 '{}'

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {
      "label": "<string>",
      "value": "<string>",
      "position": 123
    }
  },
  "links": {
    "self": "<string>"
  }
}

Update an existing custom field option.

Path parameters

Parameter	Description
definition_id	The unique identifier of the custom field definition
option_id	The unique identifier of the option

Request body

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

Authorizations

Authorization · string · header · required

Use a Terminal49 API key in the Authorization header with the Token prefix.

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

Show child attributes

Response

200 - application/json

OK

data · Custom field option · object

Show child attributes

links · link · object

Show child attributes