Skip to main content
POST
Adds prospects to an existing lead list. This endpoint supports two modes of operation:
  1. Direct Data Mode: Provide full prospect data objects directly
  2. Bulk Selection Mode: Provide a selection payload that references prospects from a search result
The endpoint automatically handles syncing prospects from the global database to the tenant database before adding them to the list.

Authentication

This endpoint requires authentication. The user must be signed in and have access to the target lead list.
Only users listed in the lead list’s userIds array (or admin users) can add prospects to the list.
This endpoint only works with person-type lead lists. Attempting to add prospects to a company-type list will result in an error.

Request

Path Parameters

string (UUID)
required
The unique identifier of the lead list to add prospects to.

Body Parameters

The request body accepts one of two formats:

Option 1: Direct Prospect Data

array
required
Array of person objects to add to the lead list. Each person object contains the prospect’s complete profile data.

Option 2: Bulk Selection

object
required
A bulk selection payload that describes which prospects to add based on a previous search.

Request Examples

Response

Returns an object indicating how many prospects were added to the lead list.
integer
required
The number of prospects that were successfully added to the lead list. This excludes any prospects that were already in the list.

Response Examples

Error Codes

Behavior Notes

Prospects that already exist in the lead list are automatically skipped. The addedCount in the response reflects only newly added prospects.
When adding prospects, the system automatically copies person records from the global database to the tenant’s database. This ensures data isolation between organizations.
This endpoint only works with person-type lead lists (type: "person"). For company-type lists, use the /add-companies endpoint instead.
The maximum number of prospects that can be selected in bulk mode is 1,000. For larger selections, make multiple API calls.