Updates the list values (and default-value pointer) of a list field.

Designed as the CLI/SDK escape hatch for system fields like Priority — the broader PUT /api/field/list rejects IsCore=true mutations from CLI/SDK callers, but admins still need to add “Critical” to Priority via script. Allowed for any caller. All other field properties (name, description, multi-select, IsCore, etc.) are preserved from the existing record.

PUT /api/field/list/data

Updates the list values (and default-value pointer) of a list field.

cURL

curl --request PUT \
  --url https://{install}/api/field/list/data \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "data": [
    {
      "id": "<string>",
      "value": "<string>",
      "image": "<string>",
      "metadata": "<string>",
      "active": true
    }
  ],
  "defaultValue": "<string>"
}
'

import requests

url = "https://{install}/api/field/list/data"

payload = {
    "id": "<string>",
    "data": [
        {
            "id": "<string>",
            "value": "<string>",
            "image": "<string>",
            "metadata": "<string>",
            "active": True
        }
    ],
    "defaultValue": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: '<string>',
    data: [
      {
        id: '<string>',
        value: '<string>',
        image: '<string>',
        metadata: '<string>',
        active: true
      }
    ],
    defaultValue: '<string>'
  })
};

fetch('https://{install}/api/field/list/data', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://{install}/api/field/list/data");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"id\": \"<string>\",\n  \"data\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"image\": \"<string>\",\n      \"metadata\": \"<string>\",\n      \"active\": true\n    }\n  ],\n  \"defaultValue\": \"<string>\"\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{install}/api/field/list/data",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '<string>',
    'data' => [
        [
                'id' => '<string>',
                'value' => '<string>',
                'image' => '<string>',
                'metadata' => '<string>',
                'active' => true
        ]
    ],
    'defaultValue' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{install}/api/field/list/data"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"data\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"image\": \"<string>\",\n      \"metadata\": \"<string>\",\n      \"active\": true\n    }\n  ],\n  \"defaultValue\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{install}/api/field/list/data")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"data\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"image\": \"<string>\",\n      \"metadata\": \"<string>\",\n      \"active\": true\n    }\n  ],\n  \"defaultValue\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{install}/api/field/list/data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"<string>\",\n  \"data\": [\n    {\n      \"id\": \"<string>\",\n      \"value\": \"<string>\",\n      \"image\": \"<string>\",\n      \"metadata\": \"<string>\",\n      \"active\": true\n    }\n  ],\n  \"defaultValue\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

Authorizations

Authorization · string · header · required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Body

application/jsonapplication/*+json

Field id plus the new list values and default-value pointer.

Inbound payload for PUT /api/field/list/data. Carries only the mutable surface -- everything else on the field record is preserved.

id · string

Id of the existing list field to update.

data · object[]

Replacement list values. Pass the full target list -- this is a whole-array replace.

Show child attributes

defaultValue · string

Id of the entry in List<DataFieldListData> UpdateFieldListDataRequest.Data that should be the default. Empty means no default.

Response

200

application/json

List data updated successfully.