Create a custom field option

Add an enum option to a custom field definition in the Terminal49 API so users can select it when applying the custom field to shipments or containers.

POST /custom_field_definitions/{definition_id}/options

Create a custom field option

cURL

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

201

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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

Parameter	Description
definition_id	The unique identifier of the custom field definition

Request body

Parameter	Required	Description
label	Yes	Display label shown to users
value	Yes	Stored value (unique per definition)
position	No	Sort 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

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

Body

application/json

data · object

Show child attributes

Response

201 - application/json

Created

data · Custom field option · object

Show child attributes

links · link · object

Show child attributes