Rename List

PATCH/v2/lists/{id}

Renames a list (its type cannot change). The new name is trimmed and must be free for the list type within the workspace: a taken name answers 409 already_exists with the existing_id of the list holding it. Renaming a list to its current name changes nothing. Free: costs no credits.

Path parameters

idstringrequired
The list id (24 hex characters).
Example: "66f1a2b3c4d5e6f7a8b9c0d1"

Body parameters

namestringrequiredmin length: 1max length: 100
New display name, trimmed. Must be free for the list type within the workspace.

Responses

200 The renamed list.
400 Invalid body (VALIDATION_ERROR with payload.code).
401 Missing, unknown or inactive credentials (UNAUTHORIZED).
404 No such list in this workspace (NOT_FOUND).
409 The name is taken: the workspace already has a live list of this type with this name, case-insensitive (CONFLICT, payload.code: already_exists with the existing_id of that list). A create retried after a lost response can treat existing_id as the list it made.
429 Too many requests (RATE_LIMIT). Not sent today: this operation is not rate limited.
500 Unexpected server error.

For error handling see Errors. The list fields are described in List object.

curl --request PATCH \
  --url https://api.getprospect.com/v2/lists/66f1a2b3c4d5e6f7a8b9c0d1 \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '
{
  "name": "Q4 SaaS founders (EU)"
}
'

Response

{
  "success": true,
  "data": {
    "id": "66f1a2b3c4d5e6f7a8b9c0d1",
    "name": "Q4 SaaS founders (EU)",
    "type": "people",
    "records_count": 128,
    "last_added_record_at": "2026-10-02T14:03:11.000Z",
    "created_at": "2026-09-28T09:12:44.000Z",
    "updated_at": "2026-10-08T12:00:00.000Z",
    "owner": {
      "id": "64f0c1d2e3f4a5b6c7d8e9f0",
      "first_name": "Dana",
      "last_name": "Reyes",
      "photo_url": null
    }
  },
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  }
}