The text column stores free-form text. The column has no fixed character limit, but each item has an approximate 64KB total column value capacity.

Via the API, the text column supports read, filter, update, and clear operations.

Queries

Text columns can be queried through the column_values field on items queries using an inline fragment on TextValue.

query {
  items(ids: [1234567890, 9876543210]) {
    column_values {
      ... on TextValue {
        text
        value
      }
    }
  }
}

Fields

You can use the following fields to specify what information your TextValue implementation will return.

Filter

You can filter items by text values using the items_page object. The text column supports the following operators:

Examples

The following example returns items whose text column is not empty.

query {
  boards(ids: 1234567890) {
    items_page(
      query_params: {
        rules: [
          {
            column_id: "text"
            compare_value: [""]
            operator: not_any_of
          }
        ]
      }
    ) {
      items {
        id
        name
      }
    }
  }
}

Mutations

Update

You can update a text column using change_simple_column_value or change_multiple_column_values. You can send values as simple strings or JSON objects, depending on the mutation you choose.

change_simple_column_value

Send the value as a plain string in value.

mutation {
  change_simple_column_value(
    item_id: 9876543210
    board_id: 1234567890
    column_id: "text"
    value: "Sample text"
  ) {
    id
  }
}

change_multiple_column_values

Send the value as a JSON string in column_values.

mutation {
  change_multiple_column_values(
    item_id: 9876543210
    board_id: 1234567890
    column_values: "{\"text\": \"Sample text\"}"
  ) {
    id
  }
}

Clear

You can clear a text column using change_simple_column_value or change_multiple_column_values.

change_simple_column_value

Pass an empty string in value.

mutation {
  change_simple_column_value(
    item_id: 9876543210
    board_id: 1234567890
    column_id: "text"
    value: ""
  ) {
    id
  }
}

change_multple_column_values

Pass null or an empty string in column_values.

mutation {
  change_multiple_column_values(
    item_id: 9876543210
    board_id: 1234567890
    column_values: "{\"text\": null}"
  ) {
    id
  }
}