Add Items to List

Add specific property or person IDs to an existing list. Up to 10,000 IDs per request. Duplicates are ignored. FREE — no credits consumed.

path list_idstringrequired

The list ID to add items to.

body idsarrayrequired

Array of property or person IDs to add (1-10,000 per request).

body id_typestringdefault: internal_property_id

Type of IDs: internal_property_id or internal_person_id.

body add_as_prospectsbooleandefault: true

Whether the records also become prospects in your workspace. Pass false to file them in the list without tracking them as prospects.

When add_as_prospects is true, new prospects count toward the workspace's prospect limit. The list write is rejected if it would pass that limit.

Response example

12345{
  "data": {
    "added": 42
  }
}