- Docs
- API reference
- Endpoints and schemas
- GraphQL
- Payload
CreateListInput
The input to `createList`.
Payload. This input holds what a write needs: the record to act on, the new values to store, or both. You pass it to createList(input).
The input to createList. It sets the name, the search, and the output columns of a new list. The account must have a pricing plan and available credits. The createList mutation does not produce a file; to produce one, use createListMaterialization.
Fields
Section titled “Fields”| Field | Type | Part | Description |
|---|---|---|---|
name |
String |
Payload | The name of the list. The name can contain only letters, numbers, underscores, hyphens, and spaces. |
listType |
ListType |
Payload | The kind of list. LIST_GENERATION finds records with a search. ENRICHMENT matches the rows of an input file. One of LIST_GENERATION, ENRICHMENT. Default: LIST_GENERATION. |
description |
String |
Payload | A description of the list. |
searchInput |
ListSearchInputInput |
Intent | The search settings that define the records of the list. |
fileFormat |
String |
File | The file format of the output file, such as CSV or PARQUET. Default: "PARQUET". |
aliases |
[FieldAliasInput] |
Selection | New names for fields of the list query. Each alias name must be unique in the list. |
columnOrdering |
[String] |
Selection | The order of the output columns, as dot-separated field paths. If you omit it, the API uses the order of the fields in the search selection. |
columnMapping |
[ColumnMappingInput] |
Match | The input file columns of an ENRICHMENT list, and the search field that each column supplies. If you set both columnMapping and columnMappings, the API uses columnMapping. |
columnMappings |
[[ColumnMappingInput]] |
Match | Groups of column mappings for an ENRICHMENT list. Each inner list is one group of search fields, so one input row can supply more than one set of match fields. |
inputFileUri |
String |
File | The reference to the uploaded input file of an ENRICHMENT list. A LIST_GENERATION list does not accept this field. |
Example
Section titled “Example”This intent writes, so the reference does not run it against production data. No response is shown.
mutation { createList(input: { name: "Texas grocery brands" listType: LIST_GENERATION searchInput: { entityType: BRAND prompt: "Grocery store brands in Texas" } }) { list { id name createdTimestamp } search { ... on Brand { id names(first: 1) { edges { node { name } } } } } }}