CRM · Prospecting
Prospects
Students and businesses being recruited. Scoring explains itself; converting hands over to SLCM or opens an account.
/api/crm/prospectsPublished as /api/v1/prospectsOverview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › Prospects on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | crm.prospects · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
13 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/prospectsList prospects
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prospect_no": "PRO-000001",
"prospect_type": "text",
"first_name": "Example",
"last_name": "Example",
"preferred_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"date_of_birth": "2026-10-30",
"country": "US",
"city": "text",
"organization_name": "Example"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/prospects?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/prospects/{id}Read one prospects
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prospect_no": "PRO-000001",
"prospect_type": "text",
"first_name": "Example",
"last_name": "Example",
"preferred_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"date_of_birth": "2026-10-30",
"country": "US",
"city": "text",
"organization_name": "Example"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/prospects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/prospectsCreate a prospects
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
location_id | uuid | No | Campus / office |
prospect_type | text | No | Type |
first_name | text | No | First name |
last_name | text | No | Last name |
preferred_name | text | No | Preferred name |
email | text | No | |
phone | text | No | Phone |
date_of_birth | date | No | Date of birth |
country | text | No | Country |
city | text | No | City |
organization_name | text | No | Organization — For a business, donor or employer prospect. |
industry | text | No | Industry |
employee_count | integer | No | Employees |
annual_revenue | numeric | No | Annual revenue |
source | text | No | Source |
source_detail | text | No | Source detail |
campaign_id | uuid | No | Campaign |
owner_id | uuid | No | Owner |
stage | text | No | Stage |
score | numeric | No | Score |
score_basis | text | No | Score basis |
rating | text | No | Rating |
interest_program_id | uuid | No | Program of interest |
interest_term_id | uuid | No | Entry term |
estimated_value | numeric | No | Estimated value |
next_action | text | No | Next action |
next_action_at | date | No | Next action due |
notes | text | No | Notes |
linkedin_url | text | No | LinkedIn profile — The person’s own profile address, linkedin.com/in/… — what Connect on LinkedIn opens. |
personal_email | text | No | Personal email |
Sample body
{
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prospect_type": "text",
"first_name": "Example",
"last_name": "Example"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prospect_no": "PRO-000001",
"prospect_type": "text",
"first_name": "Example",
"last_name": "Example",
"preferred_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"date_of_birth": "2026-10-30",
"country": "US",
"city": "text",
"organization_name": "Example"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/prospects" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","prospect_type":"text","first_name":"Example","last_name":"Example"}'PUT/api/crm/prospects/{id}Change a prospects
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
location_id | uuid | No | Campus / office |
prospect_type | text | No | Type |
first_name | text | No | First name |
last_name | text | No | Last name |
preferred_name | text | No | Preferred name |
email | text | No | |
phone | text | No | Phone |
date_of_birth | date | No | Date of birth |
country | text | No | Country |
city | text | No | City |
organization_name | text | No | Organization — For a business, donor or employer prospect. |
industry | text | No | Industry |
employee_count | integer | No | Employees |
annual_revenue | numeric | No | Annual revenue |
source | text | No | Source |
source_detail | text | No | Source detail |
campaign_id | uuid | No | Campaign |
owner_id | uuid | No | Owner |
stage | text | No | Stage |
score | numeric | No | Score |
score_basis | text | No | Score basis |
rating | text | No | Rating |
interest_program_id | uuid | No | Program of interest |
interest_term_id | uuid | No | Entry term |
estimated_value | numeric | No | Estimated value |
next_action | text | No | Next action |
next_action_at | date | No | Next action due |
notes | text | No | Notes |
linkedin_url | text | No | LinkedIn profile — The person’s own profile address, linkedin.com/in/… — what Connect on LinkedIn opens. |
personal_email | text | No | Personal email |
Sample body
{
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prospect_type": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prospect_no": "PRO-000001",
"prospect_type": "text",
"first_name": "Example",
"last_name": "Example",
"preferred_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"date_of_birth": "2026-10-30",
"country": "US",
"city": "text",
"organization_name": "Example"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/prospects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","prospect_type":"text"}'DELETE/api/crm/prospects/{id}Delete a prospects
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/prospects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/prospects/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/prospects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/crm/prospects/{parentId}/interestsInterests
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/prospects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/interests" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/prospects/{parentId}/interestsInterests
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/prospects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/interests" \
-H "Authorization: Bearer $TOKEN"PUT/api/crm/prospects/{parentId}/interests/{lineId}Interests
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/prospects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/interests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/crm/prospects/{parentId}/interests/{lineId}Interests
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/prospects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/interests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/prospects/{id}/scoreScore
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/prospects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/score" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/prospects/{id}/convertConvert
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
programId, termId, sendPaymentSetupResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/prospects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/convert" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"programId":"value","termId":"value","sendPaymentSetup":"value"}'POST/api/crm/prospects/{id}/disqualifyDisqualify
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
reason*Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/prospects/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/disqualify" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'Data model
Every field of a prospects, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
location_id | uuid | read, write | Campus / office |
prospect_no | text | read only | Prospect no |
prospect_type | text | read, write | Type |
first_name | text | read, write | First name |
last_name | text | read, write | Last name |
preferred_name | text | read, write | Preferred name |
email | text | read, write | |
phone | text | read, write | Phone |
date_of_birth | date | read, write | Date of birth |
country | text | read, write | Country |
city | text | read, write | City |
organization_name | text | read, write | Organization — For a business, donor or employer prospect. |
industry | text | read, write | Industry |
employee_count | integer | read, write | Employees |
annual_revenue | numeric | read, write | Annual revenue |
source | text | read, write | Source |
source_detail | text | read, write | Source detail |
campaign_id | uuid | read, write | Campaign |
referral_id | uuid | read only | Referral id |
owner_id | uuid | read, write | Owner |
stage | text | read, write | Stage |
score | numeric | read, write | Score |
score_basis | text | read, write | Score basis |
rating | text | read, write | Rating |
interest_program_id | uuid | read, write | Program of interest |
interest_term_id | uuid | read, write | Entry term |
estimated_value | numeric | read, write | Estimated value |
account_id | uuid | read only | Account id |
contact_id | uuid | read only | Contact id |
applicant_id | uuid | read only | Applicant id |
opportunity_id | uuid | read only | Opportunity id |
converted_at | timestamp with time zone | read only | Converted at |
disqualify_reason | text | read only | Disqualify reason |
next_action | text | read, write | Next action |
next_action_at | date | read, write | Next action due |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
linkedin_url | text | read, write | LinkedIn profile — The person’s own profile address, linkedin.com/in/… — what Connect on LinkedIn opens. |
personal_email | text | read, write | Personal email |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › Prospects for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.