Skip to main content
PATCH
/
custom_fields
/
{id}
Update a custom field
curl --request PATCH \
  --url https://api.terminal49.com/v2/custom_fields/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "type": "custom_field",
    "attributes": {
      "value": "<string>"
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "custom_field",
    "attributes": {
      "api_slug": "<string>",
      "value": "<string>",
      "display_value": "<string>"
    },
    "relationships": {
      "entity": {
        "data": {
          "type": "shipment",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "definition": {
        "data": {
          "type": "custom_field_definition",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  },
  "links": {
    "self": "<string>"
  }
}
Use this endpoint to update an existing custom field value.

​
Path parameters

ParameterDescription
idThe unique identifier of the custom field value to update

​
Request body

ParameterRequiredDescription
valueYesThe new field value (must match the definition’s data type)

​
Behavior

  • The new value is validated against the field definition’s data type
  • For enum fields, the value must match one of the definition’s configured options
  • The updated_by user is recorded for audit purposes
  • Update pathway tracking records the source of the change

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

​
id
string
required

Custom field ID

Body

application/json
​
data
object

Response

200 - application/json

OK

​
data
Custom field · object
​
links
link · object