Update a list
Rename a list or change its description.
PATCH
/api/v1/lists/:idScope
lists:writeChanges only the fields you send.
Path parameters
Prop
Type
Body
Send a JSON object.
Prop
Type
Example request
curl -X PATCH "https://api.pedibee.com/api/v1/lists/66f1c2a9e4b0a1b2c3d4e101" \
-H "Authorization: Bearer $PEDIBEE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Q4 — hot prospects"
}'Response
{
"id": "66f1c2a9e4b0a1b2c3d4e101",
"name": "Q4 — hot prospects",
"description": "Warm intros from the conference",
"contactCount": 2,
"createdAt": "2026-10-05T09:30:00.000Z",
"updatedAt": "2026-10-05T09:30:00.000Z"
}Errors
Every error is { "error": "…" } with a message you can show. See Errors and limits.
| Status | When |
|---|---|
400 | The name or description is invalid. |
403 | The key doesn’t have lists:write, or its creator’s role no longer allows it. |
404 | No list with this id in your workspace. |
409 | Another list already has this name. |
401 | The API key is missing, invalid, revoked or expired. |
429 | Too many requests. Wait for the seconds in Retry-After. |