Remove people from a list
Take people out of a list. The contacts are kept.
DELETE
/api/v1/lists/:id/contactsScope
lists:writeTakes people out of the list. They stay as contacts and in their other lists. This DELETE takes a JSON body.
Path parameters
Prop
Type
Body
Send a JSON object.
Prop
Type
Example request
curl -X DELETE "https://api.pedibee.com/api/v1/lists/66f1c2a9e4b0a1b2c3d4e101/contacts" \
-H "Authorization: Bearer $PEDIBEE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"contactIds": [
"66f1c2a9e4b0a1b2c3d4e5f6",
"66f1c2a9e4b0a1b2c3d4e5f7"
]
}'Response
How many were taken out. Ids that weren't in the list are ignored.
{
"removed": 2
}Errors
Every error is { "error": "…" } with a message you can show. See Errors and limits.
| Status | When |
|---|---|
400 | contactIds is missing or empty. |
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. |
