Skip to content
Console(opens in a new tab)

UpdateListInput

The input to `updateList`.

Payload. This input holds what a write needs: the record to act on, the new values to store, or both. You pass it to updateList(input).

The input to updateList. The update replaces the saved settings of the list. A field that you omit becomes empty in the new settings.

Field Type Part Description
id ID! Match The ID of the list to update.
name String Payload The new name of the list.
description String Payload The new description of the list.
searchInput ListSearchInputInput Intent The new search settings of the list.
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
columnMappings [[ColumnMappingInput]] Match

This intent writes, so the reference does not run it against production data. No response is shown.

mutation {
updateList(input: {
id: "00000000-0000-4000-8000-000000000001"
name: "Texas grocery brands"
description: "Grocery store brands with a location in Texas."
searchInput: {
entityType: BRAND
prompt: "Grocery store brands in Texas"
}
}) {
list { id name updatedTimestamp }
search {
... on Brand {
id
names(first: 1) { edges { node { name } } }
}
}
}
}