Skip to main content
DELETE
/
lists
/
{listId}
/
leads
Remove leads
curl --request DELETE \
  --url https://inboxapp.com/api/v1/lists/{listId}/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "platformIds": [
    "<string>"
  ]
}
'
{
  "removed": 4503599627370495
}

Documentation Index

Fetch the complete documentation index at: https://docs.inboxapp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
listId
string
required

The ID of the list to remove leads from.

Pattern: ^[0-9a-z]+$

Body

application/json
​
platformIds
string[]
required

Array of platform user IDs to remove. Maximum 2000 per request.

Required array length: 1 - 2000 elements
Minimum string length: 1
Example:
["44196397", "50393960"]

Response

200 - application/json

OK

​
removed
integer
required

The number of leads that were removed from the list.

Required range: 0 <= x <= 9007199254740991
Example:

2