## 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](/using-the-api/scopes/):** `lists:create`

**[Rate limit category](/using-the-api/rate-limits/):** Write

### Parameters

- `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.

  - `class RelationshipsAccounts: …`

    - `accounts: Union[str, Sequence[str]]`

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

      - `str`

      - `Sequence[str]`

  - `class RelationshipsContacts: …`

    - `contacts: Union[str, Sequence[str]]`

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

      - `str`

      - `Sequence[str]`

  - `class RelationshipsOpportunities: …`

    - `opportunities: Union[str, Sequence[str]]`

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

      - `str`

      - `Sequence[str]`

### Returns

- `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.

      - `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.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

  - `http_link: Optional[str]`

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

### Example

```python
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)
```

#### Response

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