Bulk Delete Records - AI CSR API

curl -X POST https://YOUR_DEPLOYMENT.lupitor.com/api/v1/records/bulk-delete \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "YOUR_CAMPAIGN_ID",
    "leads": [
      { "externalId": "CRM_001" },
      { "externalId": "CRM_002" },
      { "phoneNumber": "+15555551234" }
    ]
  }'

const response = await fetch('https://YOUR_DEPLOYMENT.lupitor.com/api/v1/records/bulk-delete', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    campaignId: 'YOUR_CAMPAIGN_ID',
    leads: [
      { externalId: 'CRM_001' },
      { externalId: 'CRM_002' },
      { phoneNumber: '+15555551234' }
    ]
  })
});

const data = await response.json();

import requests

response = requests.post(
    'https://YOUR_DEPLOYMENT.lupitor.com/api/v1/records/bulk-delete',
    headers={
        'x-api-key': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'campaignId': 'YOUR_CAMPAIGN_ID',
        'leads': [
            {'externalId': 'CRM_001'},
            {'externalId': 'CRM_002'},
            {'phoneNumber': '+15555551234'}
        ]
    }
)

print(response.json())

{
  "success": true,
  "data": {
    "deleted": 3,
    "notFound": 0,
    "deletedIdentifiers": [
      "CRM_001",
      "CRM_002",
      "+15555551234"
    ],
    "notFoundIdentifiers": []
  },
  "error": null
}

{
  "success": true,
  "data": {
    "deleted": 2,
    "notFound": 1,
    "deletedIdentifiers": [
      "CRM_001",
      "CRM_002"
    ],
    "notFoundIdentifiers": [
      "+15555551234"
    ]
  },
  "error": null
}

POST

api

records

bulk-delete

curl -X POST https://YOUR_DEPLOYMENT.lupitor.com/api/v1/records/bulk-delete \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "YOUR_CAMPAIGN_ID",
    "leads": [
      { "externalId": "CRM_001" },
      { "externalId": "CRM_002" },
      { "phoneNumber": "+15555551234" }
    ]
  }'

const response = await fetch('https://YOUR_DEPLOYMENT.lupitor.com/api/v1/records/bulk-delete', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    campaignId: 'YOUR_CAMPAIGN_ID',
    leads: [
      { externalId: 'CRM_001' },
      { externalId: 'CRM_002' },
      { phoneNumber: '+15555551234' }
    ]
  })
});

const data = await response.json();

import requests

response = requests.post(
    'https://YOUR_DEPLOYMENT.lupitor.com/api/v1/records/bulk-delete',
    headers={
        'x-api-key': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'campaignId': 'YOUR_CAMPAIGN_ID',
        'leads': [
            {'externalId': 'CRM_001'},
            {'externalId': 'CRM_002'},
            {'phoneNumber': '+15555551234'}
        ]
    }
)

print(response.json())

{
  "success": true,
  "data": {
    "deleted": 3,
    "notFound": 0,
    "deletedIdentifiers": [
      "CRM_001",
      "CRM_002",
      "+15555551234"
    ],
    "notFoundIdentifiers": []
  },
  "error": null
}

{
  "success": true,
  "data": {
    "deleted": 2,
    "notFound": 1,
    "deletedIdentifiers": [
      "CRM_001",
      "CRM_002"
    ],
    "notFoundIdentifiers": [
      "+15555551234"
    ]
  },
  "error": null
}

Endpoint Alias: This endpoint is an alias for /api/v1/leads/bulk-delete. Both endpoints are functionally identical - use whichever naming convention fits your integration.

Why POST? This endpoint uses POST instead of DELETE because DELETE requests with a body are not universally supported by all HTTP clients and proxies.

Record Lookup

Records are identified by externalId or phoneNumber, not internal IDs.

Each record must have at least one of phoneNumber or externalId. If both are provided, externalId takes priority for the lookup.

Authentication

string

required

Your API key with write scope

Request Body

string

required

The ID of the campaign these records belong to

array

required

Array of record identifiers to delete (max 1000 per request)

Show Record Identifier Properties

string

Phone number in E.164 format.Required if externalId is not provided.

string

Your CRM’s internal ID.Required if phoneNumber is not provided.

Response

boolean

Whether the request was successful

object

Show properties

number

Number of records successfully deleted

number

Number of records that were not found in the campaign

array

Array of identifiers for deleted records

array

Array of identifiers that were not found

string | null

Error message if request failed

Examples

curl -X POST https://YOUR_DEPLOYMENT.lupitor.com/api/v1/records/bulk-delete \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "YOUR_CAMPAIGN_ID",
    "leads": [
      { "externalId": "CRM_001" },
      { "externalId": "CRM_002" },
      { "phoneNumber": "+15555551234" }
    ]
  }'

const response = await fetch('https://YOUR_DEPLOYMENT.lupitor.com/api/v1/records/bulk-delete', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    campaignId: 'YOUR_CAMPAIGN_ID',
    leads: [
      { externalId: 'CRM_001' },
      { externalId: 'CRM_002' },
      { phoneNumber: '+15555551234' }
    ]
  })
});

const data = await response.json();

import requests

response = requests.post(
    'https://YOUR_DEPLOYMENT.lupitor.com/api/v1/records/bulk-delete',
    headers={
        'x-api-key': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'campaignId': 'YOUR_CAMPAIGN_ID',
        'leads': [
            {'externalId': 'CRM_001'},
            {'externalId': 'CRM_002'},
            {'phoneNumber': '+15555551234'}
        ]
    }
)

print(response.json())

{
  "success": true,
  "data": {
    "deleted": 3,
    "notFound": 0,
    "deletedIdentifiers": [
      "CRM_001",
      "CRM_002",
      "+15555551234"
    ],
    "notFoundIdentifiers": []
  },
  "error": null
}

{
  "success": true,
  "data": {
    "deleted": 2,
    "notFound": 1,
    "deletedIdentifiers": [
      "CRM_001",
      "CRM_002"
    ],
    "notFoundIdentifiers": [
      "+15555551234"
    ]
  },
  "error": null
}

Notes

Permanent Deletion: This action cannot be undone. Records will be permanently deleted.

Need the record data? Fetch the records first, then delete them.

For full documentation including best practices, see Bulk Delete Leads.

​Record Lookup

​Authentication

​Request Body

​Response

​Examples

​Notes

Record Lookup

Authentication

Request Body

Response

Examples

Notes