CRM · Automation
Sales Automation Rules
Renewals, stale pipeline, churn, lead routing, follow-ups, case assignment and field dispatch: each switched on here, with its limits and strategy. What a rule may change is the company's autonomy level for its key.
/api/crm/automation-rulesPublished as /api/v1/automation-rulesDownload specification (OpenAPI 3.1) Screen: Sales Automation Rules
Overview
| 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 › Sales Automation Rules 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.automation_rules · 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/automation-rulesList sales automation rules
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",
"rule_code": "RUL-000001",
"name": "Example",
"description": "text",
"job_code": "JOB-000001",
"job_key": "text",
"is_enabled": true,
"max_value": "1250.00",
"tolerance_pct": "1250.00",
"fence_days": 10,
"threshold": "1250.00",
"strategy": "round_robin",
"reasons": []
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/automation-rules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/automation-rules/{id}Read one automation rule
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",
"rule_code": "RUL-000001",
"name": "Example",
"description": "text",
"job_code": "JOB-000001",
"job_key": "text",
"is_enabled": true,
"max_value": "1250.00",
"tolerance_pct": "1250.00",
"fence_days": 10,
"threshold": "1250.00",
"strategy": "round_robin",
"reasons": []
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/automation-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/automation-rulesCreate a automation rule
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
description | text | No | Description |
is_enabled | boolean | No | Switched on — Off, the rule’s job finds nothing. On, what it may change is still the company’s autonomy level for the rule’s key: notify (the default) only tells people. |
max_value | numeric | No | Value limit — Nothing worth more than this is done automatically. Blank is no limit. |
tolerance_pct | numeric | No | Tolerance % — How far a quantity may differ and still match (ASN receipt). |
fence_days | integer | No | Days — The firm fence (MRP), the notice window (renewals) or the idle days (stale pipeline). |
threshold | numeric | No | Threshold — The lowest score that is acted on (sourcing award, churn). |
strategy | text | No | Strategy — Who gets a lead or a case: in turn, by territory, or whoever has the fewest open. Allowed: round_robin territory load skill |
reasons | _text | No | Reasons — Return reasons the rule approves, e.g. damaged_in_transit, wrong_item. |
settings | jsonb | No | Settings — The rule’s own named values, e.g. {"horizonDays": 90} or {"teamCode": "EAST"}. |
Sample body
{
"name": "Example",
"description": "text",
"is_enabled": true,
"max_value": "1250.00",
"tolerance_pct": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rule_code": "RUL-000001",
"name": "Example",
"description": "text",
"job_code": "JOB-000001",
"job_key": "text",
"is_enabled": true,
"max_value": "1250.00",
"tolerance_pct": "1250.00",
"fence_days": 10,
"threshold": "1250.00",
"strategy": "round_robin",
"reasons": []
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/automation-rules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","description":"text","is_enabled":true,"max_value":"1250.00","tolerance_pct":"1250.00"}'PUT/api/crm/automation-rules/{id}Change a automation rule
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 |
|---|---|---|---|
name | text | Yes | Name |
description | text | No | Description |
is_enabled | boolean | No | Switched on — Off, the rule’s job finds nothing. On, what it may change is still the company’s autonomy level for the rule’s key: notify (the default) only tells people. |
max_value | numeric | No | Value limit — Nothing worth more than this is done automatically. Blank is no limit. |
tolerance_pct | numeric | No | Tolerance % — How far a quantity may differ and still match (ASN receipt). |
fence_days | integer | No | Days — The firm fence (MRP), the notice window (renewals) or the idle days (stale pipeline). |
threshold | numeric | No | Threshold — The lowest score that is acted on (sourcing award, churn). |
strategy | text | No | Strategy — Who gets a lead or a case: in turn, by territory, or whoever has the fewest open. Allowed: round_robin territory load skill |
reasons | _text | No | Reasons — Return reasons the rule approves, e.g. damaged_in_transit, wrong_item. |
settings | jsonb | No | Settings — The rule’s own named values, e.g. {"horizonDays": 90} or {"teamCode": "EAST"}. |
Sample body
{
"name": "Example",
"description": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rule_code": "RUL-000001",
"name": "Example",
"description": "text",
"job_code": "JOB-000001",
"job_key": "text",
"is_enabled": true,
"max_value": "1250.00",
"tolerance_pct": "1250.00",
"fence_days": 10,
"threshold": "1250.00",
"strategy": "round_robin",
"reasons": []
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/automation-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","description":"text"}'DELETE/api/crm/automation-rules/{id}Delete a automation rule
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/automation-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/automation-rules/{id}/armArm
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/automation-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/arm" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/automation-rules/{id}/runRun
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/automation-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a automation rule, 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 |
rule_code | text | read only | Rule code |
name | text | read, write | Name |
description | text | read, write | Description |
job_code | text | read only | Job code |
job_key | text | read only | Job key |
is_enabled | boolean | read, write | Switched on — Off, the rule’s job finds nothing. On, what it may change is still the company’s autonomy level for the rule’s key: notify (the default) only tells people. |
max_value | numeric | read, write | Value limit — Nothing worth more than this is done automatically. Blank is no limit. |
tolerance_pct | numeric | read, write | Tolerance % — How far a quantity may differ and still match (ASN receipt). |
fence_days | integer | read, write | Days — The firm fence (MRP), the notice window (renewals) or the idle days (stale pipeline). |
threshold | numeric | read, write | Threshold — The lowest score that is acted on (sourcing award, churn). |
strategy | text | read, write | Strategy — Who gets a lead or a case: in turn, by territory, or whoever has the fewest open. Allowed: round_robin territory load skill |
reasons | _text | read, write | Reasons — Return reasons the rule approves, e.g. damaged_in_transit, wrong_item. |
settings | jsonb | read, write | Settings — The rule’s own named values, e.g. {"horizonDays": 90} or {"teamCode": "EAST"}. |
last_run_at | timestamp with time zone | read only | Last run at |
last_outcome | text | read only | Last outcome |
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 |
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 |
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 › Sales Automation Rules 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.