CRM · Prospecting
Referrals
Who was referred, by whom, what became of it and what the referrer is owed.
/api/crm/referralsPublished as /api/v1/referralsOverview
| 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 › 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. |
| Table | crm.referrals · 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
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/referralsList referrals
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",
"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
| 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",
"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.
| Field | Type | Required | Description |
|---|---|---|---|
referrer_type | text | No | Referrer type Allowed: student alumni contact account staff partner other |
referrer_id | uuid | No | Referring student |
referrer_name | text | No | Referrer name |
referrer_email | text | No | Referrer email |
referred_name | text | Yes | Referred name |
referred_email | text | No | Referred email |
referred_phone | text | No | Referred phone |
prospect_id | uuid | No | Prospect id |
program_id | uuid | No | Program |
campaign_id | uuid | No | Campaign |
status | text | No | Status Allowed: submitted contacted qualified converted declined expired duplicate |
reward_type | text | No | Reward |
reward_amount | numeric | No | Reward amount |
reward_status | text | No | Reward status Allowed: pending approved paid declined not_applicable |
notes | text | No | Notes |
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
| 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 |
|---|---|---|---|
referrer_type | text | No | Referrer type Allowed: student alumni contact account staff partner other |
referrer_id | uuid | No | Referring student |
referrer_name | text | No | Referrer name |
referrer_email | text | No | Referrer email |
referred_name | text | Yes | Referred name |
referred_email | text | No | Referred email |
referred_phone | text | No | Referred phone |
prospect_id | uuid | No | Prospect id |
program_id | uuid | No | Program |
campaign_id | uuid | No | Campaign |
status | text | No | Status Allowed: submitted contacted qualified converted declined expired duplicate |
reward_type | text | No | Reward |
reward_amount | numeric | No | Reward amount |
reward_status | text | No | Reward status Allowed: pending approved paid declined not_applicable |
notes | text | No | Notes |
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
| 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/referrals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/referrals/{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/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
| 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/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.
| 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 |
referral_no | text | read only | Referral no |
referrer_type | text | read, write | Referrer type Allowed: student alumni contact account staff partner other |
referrer_id | uuid | read, write | Referring student |
referrer_name | text | read, write | Referrer name |
referrer_email | text | read, write | Referrer email |
referred_name | text | read, write | Referred name |
referred_email | text | read, write | Referred email |
referred_phone | text | read, write | Referred phone |
prospect_id | uuid | read, write | Prospect id |
program_id | uuid | read, write | Program |
campaign_id | uuid | read, write | Campaign |
status | text | read, write | Status Allowed: submitted contacted qualified converted declined expired duplicate |
submitted_at | timestamp with time zone | read only | Submitted at |
converted_at | timestamp with time zone | read only | Converted at |
reward_type | text | read, write | Reward |
reward_amount | numeric | read, write | Reward amount |
reward_status | text | read, write | Reward status Allowed: pending approved paid declined not_applicable |
notes | text | read, write | Notes |
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_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 › Referrals 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.