TRANXACT.AI Help

CRM · Prospecting

Prospects

Students and businesses being recruited. Scoring explains itself; converting hands over to SLCM or opens an account.

Type REST13 operationsBase path /api/crm/prospectsPublished as /api/v1/prospects

Download specification (OpenAPI 3.1) Screen: Prospects

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablecrm.prospects · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
location_iduuidNoCampus / office
prospect_typetextNoType
first_nametextNoFirst name
last_nametextNoLast name
preferred_nametextNoPreferred name
emailtextNoEmail
phonetextNoPhone
date_of_birthdateNoDate of birth
countrytextNoCountry
citytextNoCity
organization_nametextNoOrganization — For a business, donor or employer prospect.
industrytextNoIndustry
employee_countintegerNoEmployees
annual_revenuenumericNoAnnual revenue
sourcetextNoSource
source_detailtextNoSource detail
campaign_iduuidNoCampaign
owner_iduuidNoOwner
stagetextNoStage
scorenumericNoScore
score_basistextNoScore basis
ratingtextNoRating
interest_program_iduuidNoProgram of interest
interest_term_iduuidNoEntry term
estimated_valuenumericNoEstimated value
next_actiontextNoNext action
next_action_atdateNoNext action due
notestextNoNotes
linkedin_urltextNoLinkedIn profile — The person’s own profile address, linkedin.com/in/… — what Connect on LinkedIn opens.
personal_emailtextNoPersonal 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
location_iduuidNoCampus / office
prospect_typetextNoType
first_nametextNoFirst name
last_nametextNoLast name
preferred_nametextNoPreferred name
emailtextNoEmail
phonetextNoPhone
date_of_birthdateNoDate of birth
countrytextNoCountry
citytextNoCity
organization_nametextNoOrganization — For a business, donor or employer prospect.
industrytextNoIndustry
employee_countintegerNoEmployees
annual_revenuenumericNoAnnual revenue
sourcetextNoSource
source_detailtextNoSource detail
campaign_iduuidNoCampaign
owner_iduuidNoOwner
stagetextNoStage
scorenumericNoScore
score_basistextNoScore basis
ratingtextNoRating
interest_program_iduuidNoProgram of interest
interest_term_iduuidNoEntry term
estimated_valuenumericNoEstimated value
next_actiontextNoNext action
next_action_atdateNoNext action due
notestextNoNotes
linkedin_urltextNoLinkedIn profile — The person’s own profile address, linkedin.com/in/… — what Connect on LinkedIn opens.
personal_emailtextNoPersonal 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, sendPaymentSetup

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/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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
location_iduuidread, writeCampus / office
prospect_notextread onlyProspect no
prospect_typetextread, writeType
first_nametextread, writeFirst name
last_nametextread, writeLast name
preferred_nametextread, writePreferred name
emailtextread, writeEmail
phonetextread, writePhone
date_of_birthdateread, writeDate of birth
countrytextread, writeCountry
citytextread, writeCity
organization_nametextread, writeOrganization — For a business, donor or employer prospect.
industrytextread, writeIndustry
employee_countintegerread, writeEmployees
annual_revenuenumericread, writeAnnual revenue
sourcetextread, writeSource
source_detailtextread, writeSource detail
campaign_iduuidread, writeCampaign
referral_iduuidread onlyReferral id
owner_iduuidread, writeOwner
stagetextread, writeStage
scorenumericread, writeScore
score_basistextread, writeScore basis
ratingtextread, writeRating
interest_program_iduuidread, writeProgram of interest
interest_term_iduuidread, writeEntry term
estimated_valuenumericread, writeEstimated value
account_iduuidread onlyAccount id
contact_iduuidread onlyContact id
applicant_iduuidread onlyApplicant id
opportunity_iduuidread onlyOpportunity id
converted_attimestamp with time zoneread onlyConverted at
disqualify_reasontextread onlyDisqualify reason
next_actiontextread, writeNext action
next_action_atdateread, writeNext action due
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
linkedin_urltextread, writeLinkedIn profile — The person’s own profile address, linkedin.com/in/… — what Connect on LinkedIn opens.
personal_emailtextread, writePersonal email

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › Prospects for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.