---
title: "Update List"
method: PUT
path: "/business/v2/dictionaries/{listId}"
tags: ["Lists"]
---

# Update List

`PUT /business/v2/dictionaries/{listId}`

## Request

- Base URL: `https://api.soldo.com`
- URL: `https://api.soldo.com/business/v2/dictionaries/{listId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.soldo.com/oauth/authorize` scopes: `tag_write`
- TypeScript: <https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/docs/business/v2/dictionaries/:listId/put.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to update the configuration of a `List`.

## Path parameters

- `listId` string, required: The `List` ID.

## Request body `application/x-www-form-urlencoded`

- object
  - `dictionary` string: The name of the `List`.
  - `uniqueSelectTag` boolean: It determines whether multiple `Tags` of the `List` can be selected.
  - `required` boolean: It determines whether it's required or not.
  - `visible` boolean: It determines whether the `List` is active.
  - `roles` string[]: List of `Roles` to can view items in transaction details.
  - `users` string[]: List of `User` IDs to can view items in transaction details..

## Response `200`

The returned resource is a single `List`.

- TagDictionary
  - `id` string: The ID of the `List`.
  - `dictionary` string: The name of the `List`.
  - `visible` boolean: It determines whether the `List` is active.
  - `creation_time` string: The date and time when the `List` was created.
  - `last_update` string: The date and time when the `List` was last updated.
  - `roles` string[]: The list of `Roles` that can view the items in the transaction details.(sortable: no).
  - `users` string[]: The list of `Users` that can view the items in the transaction details. (sortable: no).
  - `is_unique_select_tag` boolean: It determines whether multiple tags of the `List` can be selected.

## Other responses

- `400`: Your request has missing arguments or is malformed.
- `404`: One or more resource requested does not exist.

---

[API](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0.md) - [All operations](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/revisions/23fc5d07b367?raw)