Update a custom field definition

Update a custom field definition in the Terminal49 API, including its display label, data type constraints, and enum option set for shipments or containers.

PATCH /custom_field_definitions/{id}

Update a custom field definition

cURL

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

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {
      "api_slug": "<string>",
      "display_name": "<string>",
      "description": "<string>",
      "reference_type": "<string>",
      "validation": {},
      "default_format": "<string>",
      "default_value": "<string>"
    }
  },
  "links": {
    "self": "<string>"
  }
}

Update an existing custom field definition.

Path parameters

Parameter	Description
id	The unique identifier of the custom field definition

Request body

Provide the fields you want to update, such as display_name, description, validation, or default_format.

Notes

You cannot change api_slug, entity_type, or data_type after creation.

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

id · string · required

Custom field definition ID

Body

application/json

data · object

Show child attributes

Response

200 - application/json

OK

data · Custom field definition · object

Show child attributes

links · link · object

Show child attributes