Add Prospects

Track records as prospects. Records that are prospects already are returned unchanged, so retries are safe. Archived prospects come back to active. FREE, no credits consumed. The workspace's plan and prospect-capacity packages determine how many prospects it can hold.

body record_typestringdefault: property

property, person, or company.

body record_idstring

One record ID, e.g. prop_12345. Use this or record_ids.

body record_idsarray

Up to 1,000 record IDs.

body favoriteboolean

Also star the prospects for the API key's user. Ignored for keys without a user.

Request example

1234curl -X POST "https://api.v2.dealmachine.com/v1/prospects" \
  -H "Authorization: Bearer dm_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{ "record_type": "property", "record_ids": ["prop_12345", "prop_67890"] }'

Response example

12345678910111213141516171819202122232425262728293031{
  "data": {
    "created": 1,
    "existing": 1,
    "reactivated": 0,
    "prospects": [{
      "id": "prospect_8812",
      "record_type": "property",
      "record_id": "prop_12345",
      "lifecycle": "active",
      "favorite": false,
      "source": "api",
      "added_by": { "type": "api_key", "user_id": null, "name": null, "api_key_id": "key_9f1c..." },
      "record": {
        "address": "123 Main St",
        "city": "Austin",
        "state": "TX",
        "zip": "78701",
        "latitude": 30.2672,
        "longitude": -97.7431
      },
      "tags": [{ "id": "tag_1", "name": "Hot", "badge_variant": "destructive", "is_system": true }],
      "note_count": 2,
      "file_count": 0,
      "opportunity_at": null,
      "archived_at": null,
      "created_at": "2026-08-26T15:04:05.000Z",
      "updated_at": "2026-08-26T15:04:05.000Z"
    }]
  }
}