---
title: Update a list
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Rules Lists](https://developers.cloudflare.com/api/resources/rules)
[Lists](https://developers.cloudflare.com/api/resources/rules/subresources/lists)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Update a list
PUT/accounts/{account\_id}/rules/lists/{list\_id}
Updates the description of a list.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Account Filter Lists Edit`
##### P ath ParametersExpand Collapse
account\_id: string
The Account ID for this resource.
maxLength32
minLength32
[Link to this property](<#(resource)%20rules.lists%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
list\_id: string
The unique ID of the list.
maxLength32
minLength32
[Link to this property](<#(resource)%20rules.lists%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20list_id%20%3E%20(schema)>)
##### Body ParametersJSONExpand Collapse
description: optional string
An informative summary of the list.
maxLength500
[Link to this property](<#(resource)%20rules.lists%20%3E%20(method)%20update%20%3E%20(params)%200%20%3E%20(param)%20description%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(method)%20update%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(method)%20update%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: object {id, created\_on, kind, 5 more }
id: string
The unique ID of the list.
maxLength32
minLength32
Link to this property
created\_on: string
The RFC 3339 timestamp of when the list was created.
Link to this property
kind: "ip"or "redirect"or "hostname"or "asn"
The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
One of the following:
"ip"
Link to this property
"redirect"
Link to this property
"hostname"
Link to this property
"asn"
Link to this property
Link to this property
modified\_on: string
The RFC 3339 timestamp of when the list was last modified.
Link to this property
name: string
An informative name for the list. Use this name in filter and rule expressions.
maxLength50
Link to this property
num\_items: number
The number of items in the list.
Link to this property
num\_referencing\_filters: number
The number of filters referencing the list.
Link to this property
description: optional string
An informative summary of the list.
maxLength500
Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(method)%20update%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
Defines whether the API call was successful.
[Link to this property](<#(resource)%20rules.lists%20%3E%20(method)%20update%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Update a list
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rules/lists/$LIST_ID \
-X PUT \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
-d '{
"description": "This is a note"
}'
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
"created_on": "2020-01-01T08:00:00Z",
"kind": "ip",
"modified_on": "2020-01-10T14:00:00Z",
"name": "list1",
"num_items": 10,
"num_referencing_filters": 2,
"description": "This is a note"
},
"success": true
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
"created_on": "2020-01-01T08:00:00Z",
"kind": "ip",
"modified_on": "2020-01-10T14:00:00Z",
"name": "list1",
"num_items": 10,
"num_referencing_filters": 2,
"description": "This is a note"
},
"success": true
}
```