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

​
Path parameters

ParameterDescription
definition_idThe unique identifier of the custom field definition

​
Request body

ParameterRequiredDescription
labelYesDisplay label shown to users
valueYesStored value (unique per definition)
positionNoSort order for the option

​
Notes

Options can only be added to definitions with data_type of enum or enum_multi.

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

Body

application/json
​
data
object

Response

201 - application/json

Created

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