Link a referral partner, buying agent or selling agent to a record by sending their Shape record ID with an add or update request.
Endpoints
| Endpoint | Path |
|---|---|
| Add Records | POST /add/new/lead/{crmid} |
| Update Record Information | POST /update/lead/info/{crmid} |
| Bulk Import Records | POST /leads/bulk/import/{crmid} |
| Bulk Update Records | POST /leads/bulk/update/{crmid} |
Fields
| Field | Links | Value |
|---|---|---|
realtorId |
Referral partner | The partner’s Shape record ID. |
relbuyingagentID |
Buying agent | The agent’s Shape record ID or loan GUID. |
relsellingagentID |
Selling agent | The agent’s Shape record ID or loan GUID. |
The loan GUID is the unique loan identifier from your loan origination system (LOS). The linked record must be an existing Referral Partner record in the same system. IDs can be sent as text or numbers.
A record has one referral partner, one buying agent and one selling agent. Sending a new ID replaces the current link. Send {delete} to remove it. On Update Record Information, linking works whether the record is identified by lead_id or trkloannnumber. Bulk Update Records needs lead_id.
Example request
{
"firstname": "Jordan",
"lastname": "Sample",
"phone": "5550100123",
"email": "jordan.sample@example.com",
"source": "Email",
"realtorId": "239718",
"relbuyingagentID": "239715",
"relsellingagentID": "239712"
}Example response
{
"message": "Record successfully received.",
"recordId": 240642,
"systemId": 1360
}If a link doesn’t appear, check that the ID belongs to an existing Referral Partner record in your system. An ID that doesn’t match is skipped, and the rest of the request is still saved.