Skip to content
Lightfield Lightfield
API Reference
List

Create a list

list.create(ListCreateParams**kwargs) -> ListCreateResponse
POST/v1/lists

Creates a new list. The $name and $objectType fields are required.

Supports idempotency via the Idempotency-Key header.

Required scope: lists:create

Rate limit category: Write

ParametersExpand Collapse
fields: Fields

Field values for the new list. Required: $name (string) and $objectType.

name: str

Display name of the list.

object_type: str

The type of entities this list contains. One of account, contact, or opportunity.

relationships: Optional[Relationships]

Relationships to set on the new list.

One of the following:
class RelationshipsAccounts: …
accounts: Union[str, Sequence[str]]

Account ID(s) to add as initial members. List $objectType must be account.

One of the following:
str
Sequence[str]
class RelationshipsContacts: …
contacts: Union[str, Sequence[str]]

Contact ID(s) to add as initial members. List $objectType must be contact.

One of the following:
str
Sequence[str]
class RelationshipsOpportunities: …
opportunities: Union[str, Sequence[str]]

Opportunity ID(s) to add as initial members. List $objectType must be opportunity.

One of the following:
str
Sequence[str]
ReturnsExpand Collapse
class ListCreateResponse: …
id: str

Unique identifier for the list.

created_at: str

ISO 8601 timestamp of when the list was created.

fields: Dict[str, Fields]

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

value: Optional[FieldsValue]

The field value, or null if unset.

One of the following:
str
float
bool
List[str]
class FieldsValueAddress: …
city: Optional[str]

City name.

country: Optional[str]

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

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class FieldsValueFullName: …
first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]

The data type of the field.

One of the following:
"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"

Create a list

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
list_create_response = client.list.create(
    fields={
        "name": "$name",
        "object_type": "$objectType",
    },
)
print(list_create_response.id)
{
  "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"
}