Delete a list

DELETE/api/v1/lists/:id

Scopelists:write

Deletes the list. Its people stay as contacts; they're only taken out of this list. removedFrom says how many were in it.

Path parameters

Prop

Type

curl -X DELETE "https://api.pedibee.com/api/v1/lists/66f1c2a9e4b0a1b2c3d4e101" \
  -H "Authorization: Bearer $PEDIBEE_API_KEY"

200 OK

{
  "deleted": true,
  "id": "66f1c2a9e4b0a1b2c3d4e101",
  "removedFrom": 2
}

Every error is { "error": "…" } with a message you can show. See Errors and limits.

Status	When
`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.
`401`	The API key is missing, invalid, revoked or expired.
`429`	Too many requests. Wait for the seconds in `Retry-After`.