TRANXACT.AI Help

CRM · Lead Scoring

Lead Scoring Models

How leads are scored: weighted rules on what a lead is and what it has done, or a model trained from the leads you converted and lost. One is active; grades A-D, and what happens at each threshold.

Type REST11 operationsBase path /api/crm/lead-scoring-modelsPublished as /api/v1/lead-scoring-models

Download specification (OpenAPI 3.1) Screen: Lead Scoring Models

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 › Lead Scoring Models 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.lead_scoring_models · 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

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

GET/api/crm/lead-scoring-modelsList lead scoring models

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",
      "model_no": "MOD-000001",
      "name": "Example",
      "kind": "rules",
      "status": "draft",
      "is_active": true,
      "grade_a_min": "1250.00",
      "grade_b_min": "1250.00",
      "grade_c_min": "1250.00",
      "auto_qualify": true,
      "qualify_threshold": "1250.00",
      "route_threshold": "1250.00",
      "route_to_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "model_no": "MOD-000001",
  "name": "Example",
  "kind": "rules",
  "status": "draft",
  "is_active": true,
  "grade_a_min": "1250.00",
  "grade_b_min": "1250.00",
  "grade_c_min": "1250.00",
  "auto_qualify": true,
  "qualify_threshold": "1250.00",
  "route_threshold": "1250.00",
  "route_to_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
nametextYesName
kindtextNoKind — Rules: points you set. Logistic: weights learnt from converted and lost leads.
Allowed: rules logistic
grade_a_minnumericNoGrade A from
grade_b_minnumericNoGrade B from
grade_c_minnumericNoGrade C from
auto_qualifybooleanNoQualify automatically
qualify_thresholdnumericNoQualify at score
route_thresholdnumericNoRoute at score
route_to_user_iduuidNoRoute to
decay_half_life_daysintegerNoEngagement half-life (days) — An activity this old counts half; twice as old, a quarter.
rescore_on_changebooleanNoRescore when a lead changes
descriptiontextNoDescription

Sample body

{
  "name": "Example",
  "kind": "rules",
  "grade_a_min": "1250.00",
  "grade_b_min": "1250.00",
  "grade_c_min": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "model_no": "MOD-000001",
  "name": "Example",
  "kind": "rules",
  "status": "draft",
  "is_active": true,
  "grade_a_min": "1250.00",
  "grade_b_min": "1250.00",
  "grade_c_min": "1250.00",
  "auto_qualify": true,
  "qualify_threshold": "1250.00",
  "route_threshold": "1250.00",
  "route_to_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/lead-scoring-models" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","kind":"rules","grade_a_min":"1250.00","grade_b_min":"1250.00","grade_c_min":"1250.00"}'
PUT/api/crm/lead-scoring-models/{id}Change a lead scoring models

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
nametextYesName
kindtextNoKind — Rules: points you set. Logistic: weights learnt from converted and lost leads.
Allowed: rules logistic
grade_a_minnumericNoGrade A from
grade_b_minnumericNoGrade B from
grade_c_minnumericNoGrade C from
auto_qualifybooleanNoQualify automatically
qualify_thresholdnumericNoQualify at score
route_thresholdnumericNoRoute at score
route_to_user_iduuidNoRoute to
decay_half_life_daysintegerNoEngagement half-life (days) — An activity this old counts half; twice as old, a quarter.
rescore_on_changebooleanNoRescore when a lead changes
descriptiontextNoDescription

Sample body

{
  "name": "Example",
  "kind": "rules"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "model_no": "MOD-000001",
  "name": "Example",
  "kind": "rules",
  "status": "draft",
  "is_active": true,
  "grade_a_min": "1250.00",
  "grade_b_min": "1250.00",
  "grade_c_min": "1250.00",
  "auto_qualify": true,
  "qualify_threshold": "1250.00",
  "route_threshold": "1250.00",
  "route_to_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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/lead-scoring-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/lead-scoring-models/{id}/activateActivate

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/lead-scoring-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/activate" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/lead-scoring-models/{id}/deactivateDeactivate

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/lead-scoring-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/deactivate" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/lead-scoring-models/{id}/trainTrain

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):

holdoutPct

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/lead-scoring-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/train" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"holdoutPct":"value"}'
POST/api/crm/lead-scoring-models/{id}/rescore-allRescore all

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/lead-scoring-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rescore-all" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/lead-scoring-models/{id}/previewPreview

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):

leadId

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

Data model

Every field of a lead scoring models, 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
model_notextread onlyModel no
nametextread, writeName
kindtextread, writeKind — Rules: points you set. Logistic: weights learnt from converted and lost leads.
Allowed: rules logistic
statustextread onlyStatus
is_activebooleanread onlyIs active
grade_a_minnumericread, writeGrade A from
grade_b_minnumericread, writeGrade B from
grade_c_minnumericread, writeGrade C from
auto_qualifybooleanread, writeQualify automatically
qualify_thresholdnumericread, writeQualify at score
route_thresholdnumericread, writeRoute at score
route_to_user_iduuidread, writeRoute to
decay_half_life_daysintegerread, writeEngagement half-life (days) — An activity this old counts half; twice as old, a quarter.
rescore_on_changebooleanread, writeRescore when a lead changes
interceptnumericread onlyIntercept
coefficientsjsonbread onlyCoefficients
trainingjsonbread onlyTraining
trained_attimestamp with time zoneread onlyTrained at
descriptiontextread, writeDescription
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 › Lead Scoring Models 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.