Update (PUT) Item in a List

Use this API to update a single list item by specifying the code table and code. The Labels and Lists section includes global labels and lists options. Lists contain values to populate drop-down lists used throughout the product. These lists save time during routine entry and enforce uniformity in data fields. You can update the lists in the browser tool or via the API.

To update a list item:

Execute a GET command on the endpoint {{url}}/codeTable/<codetable>/code, where the codetable variable is the name of the list you want to read and code is the value of the list item you want to update.

For example, here is a request, using cURL, to update a for an employee by setting the codetable variable to CFGClientCurrentStatus and setting the list item variable code to Prospect. For a list of code table values, see GUID-9B82635D-5ED2-41EA-8FA1-C2882CFC3561.

curl --request PUT \
  --url 'https://{{url}}/codeTable/CFGCurrentStatus/Prospect' \
  --header 'authorization: Bearer {{oauth_token}}' \
  --header 'content-type: application/json'
  --data '{
        "Description": "Prospect description that has been updated"
    }'

The call returns the JSON representation of the list item that has been updated, for example:

[
    {
        "Code": "Prospect",
        "Description": "Prospect description that has been updated",
        "Seq": 3
    }
]