Update a custom field

Update the stored value on a custom field record in the Terminal49 API. The associated definition slug and parent resource reference remain unchanged.

PATCH /custom_fields/{id}

Update a custom field

cURL

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

200

{
  "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 update an existing custom field value.

Path parameters

Parameter	Description
id	The unique identifier of the custom field value to update

Request body

Parameter	Required	Description
value	Yes	The 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

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 ID

Body

application/json

data · object

Show child attributes

Response

200 - application/json

OK

data · Custom field · object

Show child attributes

links · link · object

Show child attributes