Create a custom field

Create a custom field value record in the Terminal49 API, attaching a definition and value to a target shipment, container, or other supported resource.

POST /custom_fields

Create a custom field

cURL

curl --request POST \
  --url https://api.terminal49.com/v2/custom_fields \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

201

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {
      "api_slug": "<string>",
      "value": "<string>",
      "display_value": "<string>"
    },
    "relationships": {
      "entity": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "definition": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  },
  "links": {
    "self": "<string>"
  }
}

Use this endpoint to create a custom field value on a shipment or container. The field must reference an existing custom field definition.

Request body

Parameter	Required	Description
entity	Yes	Polymorphic relationship to a Shipment or Container
api_slug	Yes	The slug of the custom field definition
value	Yes	The field value (must match the definition’s data type)

Value formats by data type

Data type	Expected value format
short_text	Any string
number	Numeric value
date	Date string (parsed using definition’s default_format or flexible parsing)
datetime	DateTime string
boolean	true or false
enum	String matching one of the definition’s option values
enum_multi	Array of strings matching the definition’s option values
reference	Object identifying the referenced record, for example { "type": "shipment", "id": "SHIPMENT_ID" }

Validation

• Values are validated against the definition’s data type
• Enum values must match one of the definition’s configured options
• Reference values must match the definition’s configured reference_type
• The api_slug must reference a definition belonging to your account or a Terminal49 template

Authorizations

Authorization · string · header · required

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

Authorization: Token YOUR_API_KEY

Body

application/json

data · object

Show child attributes

Response

201 - application/json

Created

data · Custom field · object

Show child attributes

links · link · object

Show child attributes