Skip to main content
PATCH
/
v2
/
lists
/
{id}
Update a list
curl --request PATCH \
  --url https://api.village.do/v2/lists/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Updated Sales Leads",
  "description": "Updated description for the list"
}
'
{
  "data": {
    "id": 123,
    "title": "<string>",
    "type": "people",
    "description": "<string>",
    "item_count": 123,
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "metadata": {
    "request_id": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Use the API token from your personal Village account: https://village.do/settings#api-keys

For verified apps accessing user data, create a user token: https://docs.village.do/api-reference-v2/authentication/create-authorization

Path Parameters

id
string
required

List ID

Minimum string length: 1
Example:

"123"

Body

application/json

Request body for updating list metadata

title
string

New list title

Required string length: 1 - 255
Example:

"Updated Sales Leads"

description
string | null

New list description (null to clear)

Maximum string length: 1000
Example:

"Updated description for the list"

Response

List updated successfully

data
object
required

Response after updating a list

metadata
object
required