Update a list

POST/v1/lists/{id}

Updates an existing list by ID. Only included fields are modified.

Supports idempotency via the Idempotency-Key header.

Required scope: lists:update

Rate limit category: Write

Path ParametersExpand Collapse

id: string

Unique identifier of the list to update.

Body ParametersJSONExpand Collapse

fields: optional object { "$name" }

Field values to update — only provided fields are modified; omitted fields are left unchanged.

"$name": optional string

Display name of the list.

relationships: optional object { "$accounts" } or object { "$contacts" } or object { "$opportunities" }

Relationship operations. Use the key matching the list's $objectType (e.g. $accounts for an account list).

Accepts one of the following:

Accounts = object { "$accounts" }

"$accounts": object { add, remove }

Add/remove accounts. List $objectType must be account.

add: optional string or array of string

Entity ID(s) to add to the list.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

remove: optional string or array of string

Entity ID(s) to remove from the list.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

Contacts = object { "$contacts" }

"$contacts": object { add, remove }

Add/remove contacts. List $objectType must be contact.

add: optional string or array of string

Entity ID(s) to add to the list.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

remove: optional string or array of string

Entity ID(s) to remove from the list.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

Opportunities = object { "$opportunities" }

"$opportunities": object { add, remove }

Add/remove opportunities. List $objectType must be opportunity.

add: optional string or array of string

Entity ID(s) to add to the list.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

remove: optional string or array of string

Entity ID(s) to remove from the list.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

ReturnsExpand Collapse

ListUpdateResponse = object { id, createdAt, fields, httpLink }

id: string

Unique identifier for the list.

createdAt: string

ISO 8601 timestamp of when the list was created.

fields: map[object { value, valueType } ]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $objectType).

value: string or number or boolean or 3 more

The field value, or null if unset.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = array of string

Address = object { city, country, latitude, 5 more }

city: optional string

City name.

country: optional string

2-letter ISO 3166-1 alpha-2 country code.

latitude: optional number

Latitude coordinate.

longitude: optional number

Longitude coordinate.

postalCode: optional string

Postal or ZIP code.

state: optional string

State or province.

street: optional string

Street address line 1.

street2: optional string

Street address line 2.

FullName = object { firstName, lastName }

firstName: optional string

The contact's first name.

lastName: optional string

The contact's last name.

valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more

The data type of the field.

Accepts one of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

httpLink: string

URL to view the list in the Lightfield web app, or null.

Update a list

curl https://api.lightfield.app/v1/lists/$ID \
    -H 'Content-Type: application/json' \
    -H 'Lightfield-Version: 2026-03-01' \
    -H "Authorization: Bearer $API_KEY" \
    -d '{}'

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink"
}

Returns Examples

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink"
}