Update a list's contents

put/lists/{listId}/contents

Update the contents of a list synchronously via a JSON request body. An update can include the removal of list records.

A request body to update a list's contents must contain a collection of data record objects with key-value pairs that match the column definitions.

To insert a record, all key and data column values are required.

Updating and deleting records varies based on the 'duplicateKeysEnabled' property of the list.

When 'duplicateKeysEnabled' is set to false:

To update a record, all key column values are required and only the data column values that are provided are updated.
To delete a record, all key column values are required.

When 'duplicateKeysEnabled' is set to true:

Records might not be updated, because new entries with key and data column values can be inserted.
To delete a record, all key and data column values are required.

The contents of the list can be edited only if the most recent revision is the deployed revision.

Request Samples

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  "duplicateKeysEnabled": false,
12  "columns": [
13    {
14      "name": "userId",
15      "dataType": "string",
16      "position": 1,
17      "isKey": true,
18      "keyPosition": 1
19    },
20    {
21      "name": "firstName",
22      "dataType": "string",
23      "position": 2,
24      "isKey": false,
25      "keyPosition": 0
26    },
27    {
28      "name": "lastName",
29      "dataType": "string",
30      "position": 3,
31      "isKey": false,
32      "keyPosition": 0
33    },
34    {
35      "name": "salary",
36      "dataType": "number",
37      "position": 4,
38      "isKey": false,
39      "keyPosition": 0,
40      "dataMask": {
41        "name": "MaskStart",
42        "regex": ".(....$)|.",
43        "replace": "*$1",
44        "example": "****1234"
45      }
46    }
47  ],
48  "label": "corporate marketing",
49  "links": [
50    {
51      "href": "...",
52      "method": "...",
53      "rel": "...",
54      "uri": "..."
55    }
56  ]
57}

Path Parameters

Name	Type	Required	Description
listId	string	true	A universally unique identifier for a list.

Query Parameters

Name	Type	Required	Description
op	string	false	The operation type for the PUT method. Supported operations are 'upsert', which updates or inserts records, and 'delete', which deletes existing records. Default: upsert

Request Body

Name	Type	Required	Description
items	array [object]	false

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
403	Forbidden	The user did not have the necessary permissions.		Schema
404	Not Found	No item exists at the requested path.		Schema
409	Conflict	The request could not be completed due to a conflict with an existing resource.		Schema
500	Internal Server Error	The request could not be fulfilled because of an unexpected server error.		Schema