Lists

Update a list

Update a list's metadata. Use this to rename a list, change its description, toggle notifications_enabled (opt the list into the daily new-search-results email), or publish/unpublish it via is_public. Provide at least one of: title, description, notifications_enabled, or is_public. The list type cannot be changed after creation. Returns the updated list with new timestamps.

patch/v2/lists/{id}

Request

  • Base URL: https://api.village.ai
  • URL: https://api.village.ai/v2/lists/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

List ID

Example:123

Request body

titlestring

New list title

descriptionstring nullable

New list description (null to clear)

notifications_enabledboolean

Opt the list into the daily "new search results" email sweep (off by default)

is_publicboolean

Publish the list, or unpublish it. A published list is readable by anyone holding its public identifier — names, titles, companies and screening scores, never contact details or introduction paths. Publishing mints that identifier the first time and returns it as slug; unpublishing keeps it, so republishing later restores the same URL.

Example request

{
  "title": "Updated Sales Leads",
  "description": "Updated description for the list",
  "notifications_enabled": true,
  "is_public": true
}

Response

List updated successfully

Example response

{
  "data": {
    "public_id": "fintech-8f3k2"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.