Create tracking request custom field

Create or update a custom field value on a tracking request in the Terminal49 API. Attach internal metadata like references, intake tags, or workflow flags.

POST /tracking_requests/{tracking_request_id}/custom_fields

Create a tracking request custom field

cURL

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

201

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

Creates or updates a custom field on a tracking request. If a custom field with the specified api_slug already exists, it will be updated.

Path parameters

Parameter	Required	Description
tracking_request_id	Yes	The ID of the tracking request

Request body

Parameter	Required	Description
api_slug	Yes	The slug of the custom field definition
value	Yes	The value to set (type depends on the definition’s data type)

Authorization

Requires update permission on the tracking request.

Response

Returns 201 Created with the custom field resource on success.

Behavior

• Uses find_or_initialize_by internally, so it creates if missing or updates if it exists
• Values are validated against the definition’s data type
• For enum fields, values are validated against the definition’s options

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

tracking_request_id · string · required

Tracking request ID

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