Update a list's properties

put/lists/{listId}
Internal-Use Only

Updates a list's properties.

In some situations, you cannot edit properties that are not marked as Read-Only.

Restricted Updates When a List Contains Contents

Once a list has contents, you cannot update the following properties:

  • 'name'
  • 'isImmutable'
  • 'columns'
  • 'ColumnInfo' objects in 'columns'
    • 'name'
    • 'dataType'
    • 'position'
    • 'isKey'
    • 'keyPosition'
    • 'dataMask'

Administrative Editing Privileges

From the list above, only the 'dataMask' property for the 'ColumnInfo' object can be modified after a list has contents. A user with privileged authorization can create, update, and delete the 'dataMask' property for the 'ColumnInfo' object.

See the endpoint /lists/{listId}/privilegedEdit for more details.

Request Samples

1

Response Samples

1{
2  "id": "3659ea38-2618-4474-aeac-0bf6cfd3c322",
3  "version": 1,
4  "creationTimeStamp": "2022-03-01T20:18:32Z",
5  "modifiedTimeStamp": "2022-03-01T20:18:32Z",
6  "createdBy": "appUser1",
7  "modifiedBy": "appUser1",
8  "name": "list-a",
9  "description": "The A-list users",
10  "state": "developing",
11  "columns": [
12    {
13      "name": "userId",
14      "dataType": "string",
15      "position": 1,
16      "isKey": true,
17      "keyPosition": 1
18    },
19    {
20      "name": "firstName",
21      "dataType": "string",
22      "position": 2,
23      "isKey": false,
24      "keyPosition": 0
25    },
26    {
27      "name": "lastName",
28      "dataType": "string",
29      "position": 3,
30      "isKey": false,
31      "keyPosition": 0
32    },
33    {
34      "name": "salary",
35      "dataType": "number",
36      "position": 4,
37      "isKey": false,
38      "keyPosition": 0,
39      "dataMask": {
40        "name": "MaskStart",
41        "regex": ".(....$)|.",
42        "replace": "*$1",
43        "example": "****1234"
44      }
45    }
46  ],
47  "label": "corporate marketing",
48  "links": [
49    {
50      "href": "...",
51      "method": "...",
52      "rel": "...",
53      "uri": "..."
54    }
55  ]
56}

Path Parameters

NameTypeRequiredDescription
listId
string
true

A universally unique identifier for a list.

Examples:
"3659ea38-2618-4474-aeac-0bf6cfd3c322"

Request Body

This schema defines the list properties.

NameTypeRequiredDescription
name
string
true

The name of the list. The list name is not case-sensitive, must be unique within the system, and cannot be updated once it is created.

Example:
"list-a"
state
string
true

An indicator for whether the list can be used by deployed artifacts. A list can be either deployed or developing. Only lists in developing can be deleted.

Default:
developing
Example:
"developing"
description
string or null
false

A textual description of the list.

Default:
isImmutable
boolean
false

An indicator for whether the list's contents can be altered after it is imported.

Default:
false
columns
array [Column Information]
true

Columns are a collection of 'ColumnInfo' objects that define the structure of the list's content. 'ColumnInfo' objects map properties such as name, position, and data type to the imported source data (for example, a CSV file). Columns also mark which values are used to construct lookup keys. Key properties are flagged as such and are assigned a position for where their values are placed in the lookup key.

The number of columns in the data source's header must match the number of columns (that is, the number of 'ColumnInfo' objects) that are defined for a list. The value for the 'ColumnInfo' position's object must be a sequential set of positions such as 1..N, where N is the number of columns in the header. For example, if the input data has a 3-column header, there must be a 'ColumnInfo' object for each position 1, 2, and 3.

>= 1 items
defaultExpiry
number
false

The value that sets the expiration of newly added rows.

Example:
10000
label
string or null
false

A short textual label, which is appropriate for client UIs.

Responses

StatusMeaningDescription
200OKThe request succeeded.HeadersSchema
400Bad RequestThe request was invalid.Schema
403ForbiddenThe user did not have the necessary permissions.Schema
404Not FoundNo item exists at the requested path.Schema
500Internal Server ErrorThe request could not be fulfilled because of an unexpected server error.Schema