Action ID
:   `actions.intent.UPDATE_ITEM_LIST`

Description

:   Add an item to an existing list. Determine which list to modify by filtering the user's lists
    using the `itemList.name` parameter. If a single list cannot be identified from the parameters, ask the user to determine
    which list to edit before proceeding.

    Once a single list is identified, add an item with the value of the
    `itemList.itemListElement.name` parameter.


    We also recommend integrating our [partner
    solution](https://developer.android.com/assistant/docs#solutions-for-partners) enabling notes and list access through a native Assistant experience that works
    across a variety of Assistant-enabled devices.

## Example queries

#### en-US

- Add milk to my ExampleProvider list.
- Add eggs to my ExampleProvider shopping list.
- Add eggs to my grocery list on ExampleProvider.

## Recommended fields

The following fields represent essential information that users often
provide in queries that trigger this built-in intent:
[`itemList.itemListElement.name`](https://schema.googleapis.com/name)   
[`itemList.name`](https://schema.googleapis.com/name)   

## Other supported fields

The following fields represent information that users often provide to
disambiguate their needs or otherwise improve their results:
[`itemList.@type`](https://schema.googleapis.com/ItemList)   
[`itemList.itemListElement.@type`](https://schema.googleapis.com/itemListElement)   

## Supported text values by field

`itemList.@type`

- ItemList

`itemList.itemListElement.@type`

- ListItem

## Sample XML files

For information about the `shortcuts.xml` schema, see [Create shortcuts.xml](https://developer.android.com/guide/app-actions/action-schema).


| **Deprecation notice:** Google is ending support for App Actions implemented using the
| `actions.xml` resource file. Please use the
| [Actions.xml migration guide](https://developer.android.com/guide/app-actions/legacy/migration-guide) to update your
| actions to use the fully supported Android Shortcuts framework. For details on
| the Shortcuts framework, see [App Actions overview](https://developer.android.com/guide/app-actions/overview).

<br />

### Handle BII parameters

### shortcuts.xml


```world-of-warcraft-toc
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample shortcuts.xml -->
<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
  <capability android:name="actions.intent.UPDATE_ITEM_LIST">
    <intent
      android:action="android.intent.action.VIEW"
      android:targetPackage="YOUR_UNIQUE_APPLICATION_ID"
      android:targetClass="YOUR_TARGET_CLASS">
      <!-- Eg. itemListName = "Grocery List" -->
      <parameter
        android:name="itemList.name"
        android:key="itemListName"/>
      <!-- Eg. itemListElementName = "Milk" -->
      <parameter
        android:name="itemList.itemListElement.name"
        android:key="itemListElementName"/>
    </intent>
  </capability>
</shortcuts>
      
```

<br />

### actions.xml


```world-of-warcraft-toc
<?xml version="1.0" encoding="utf-8"?>
<!-- This is a sample actions.xml -->
<actions>
  <action intentName="actions.intent.UPDATE_ITEM_LIST">
    <fulfillment urlTemplate="myapp://custom-deeplink{?itemListName,itemListElementName}">
      <!-- e.g. itemListName = "Grocery List" -->
      <!-- (Optional) Require a field eg.itemListName for fulfillment with required="true" -->
      <parameter-mapping urlParameter="itemListName" intentParameter="itemList.name" required="true" />
      <!-- e.g. itemListElementName = "Milk" -->
      <parameter-mapping urlParameter="itemListElementName" intentParameter="itemList.itemListElement.name" />
    </fulfillment>

    <!-- Provide a fallback fulfillment with no required parameters. For example, to your app search or router deeplink -->
    <fulfillment urlTemplate="myapp://deeplink" />
  </action>
</actions>
```

<br />

## JSON-LD sample

The following JSON-LD sample provides some example values that you can
use in the App Actions test tool:

```carbon
{
  "@context": "http://schema.org",
  "@type": "ItemList",
  "itemListElement": {
    "@type": "ListItem",
    "name": "Milk"
  },
  "name": "Grocery List"
}
```