TRANXACT.AI Help

CRM · Prospecting

Referrals

Who was referred, by whom, what became of it and what the referrer is owed.

Type REST7 operationsBase path /api/crm/referralsPublished as /api/v1/referrals

Download specification (OpenAPI 3.1) Screen: Referrals

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 › Referrals 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.referrals · 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

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/crm/referralsList referrals

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",
      "referral_no": "REF-000001",
      "referrer_type": "student",
      "referrer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "referrer_name": "Example",
      "referrer_email": "someone@example.com",
      "referred_name": "Example",
      "referred_email": "someone@example.com",
      "referred_phone": "+1 555 0100",
      "prospect_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "status": "submitted"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/crm/referrals?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/referrals/{id}Read one referrals

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",
  "referral_no": "REF-000001",
  "referrer_type": "student",
  "referrer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "referrer_name": "Example",
  "referrer_email": "someone@example.com",
  "referred_name": "Example",
  "referred_email": "someone@example.com",
  "referred_phone": "+1 555 0100",
  "prospect_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "submitted"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/crm/referrals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/referralsCreate a referrals

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
referrer_typetextNoReferrer type
Allowed: student alumni contact account staff partner other
referrer_iduuidNoReferring student
referrer_nametextNoReferrer name
referrer_emailtextNoReferrer email
referred_nametextYesReferred name
referred_emailtextNoReferred email
referred_phonetextNoReferred phone
prospect_iduuidNoProspect id
program_iduuidNoProgram
campaign_iduuidNoCampaign
statustextNoStatus
Allowed: submitted contacted qualified converted declined expired duplicate
reward_typetextNoReward
reward_amountnumericNoReward amount
reward_statustextNoReward status
Allowed: pending approved paid declined not_applicable
notestextNoNotes

Sample body

{
  "referred_name": "Example",
  "referrer_type": "student",
  "referrer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "referrer_name": "Example",
  "referrer_email": "someone@example.com"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "referral_no": "REF-000001",
  "referrer_type": "student",
  "referrer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "referrer_name": "Example",
  "referrer_email": "someone@example.com",
  "referred_name": "Example",
  "referred_email": "someone@example.com",
  "referred_phone": "+1 555 0100",
  "prospect_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "submitted"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/referrals" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"referred_name":"Example","referrer_type":"student","referrer_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","referrer_name":"Example","referrer_email":"someone@example.com"}'
PUT/api/crm/referrals/{id}Change a referrals

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
referrer_typetextNoReferrer type
Allowed: student alumni contact account staff partner other
referrer_iduuidNoReferring student
referrer_nametextNoReferrer name
referrer_emailtextNoReferrer email
referred_nametextYesReferred name
referred_emailtextNoReferred email
referred_phonetextNoReferred phone
prospect_iduuidNoProspect id
program_iduuidNoProgram
campaign_iduuidNoCampaign
statustextNoStatus
Allowed: submitted contacted qualified converted declined expired duplicate
reward_typetextNoReward
reward_amountnumericNoReward amount
reward_statustextNoReward status
Allowed: pending approved paid declined not_applicable
notestextNoNotes

Sample body

{
  "referred_name": "Example",
  "referrer_type": "student"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "referral_no": "REF-000001",
  "referrer_type": "student",
  "referrer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "referrer_name": "Example",
  "referrer_email": "someone@example.com",
  "referred_name": "Example",
  "referred_email": "someone@example.com",
  "referred_phone": "+1 555 0100",
  "prospect_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "submitted"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/referrals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"referred_name":"Example","referrer_type":"student"}'
DELETE/api/crm/referrals/{id}Delete a referrals

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/referrals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/referrals/{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/referrals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/crm/referrals/{id}/convert-to-prospectConvert to prospect

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/referrals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/convert-to-prospect" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a referrals, 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
referral_notextread onlyReferral no
referrer_typetextread, writeReferrer type
Allowed: student alumni contact account staff partner other
referrer_iduuidread, writeReferring student
referrer_nametextread, writeReferrer name
referrer_emailtextread, writeReferrer email
referred_nametextread, writeReferred name
referred_emailtextread, writeReferred email
referred_phonetextread, writeReferred phone
prospect_iduuidread, writeProspect id
program_iduuidread, writeProgram
campaign_iduuidread, writeCampaign
statustextread, writeStatus
Allowed: submitted contacted qualified converted declined expired duplicate
submitted_attimestamp with time zoneread onlySubmitted at
converted_attimestamp with time zoneread onlyConverted at
reward_typetextread, writeReward
reward_amountnumericread, writeReward amount
reward_statustextread, writeReward status
Allowed: pending approved paid declined not_applicable
notestextread, writeNotes
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_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Referrals 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.