Platform · Email
Email Rules
Your own decision about an event: who receives it and in what words. Any rule for an event replaces its default, so an inactive rule is how an event is switched off. Any screen’s <module>.<screen>.created, .updated or .status_changed can have a rule.
/api/platform/mail-rulesPublished as /api/v1/mail-rulesOverview
| Package | Platform |
|---|---|
| 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 Platform › Email 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 | platform.mail_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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/mail-rulesList email 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",
"event_code": "EVE-000001",
"name": "Example",
"recipients": {},
"subject": "text",
"body": "text",
"is_active": true,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/mail-rules?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/mail-rules/{id}Read one email 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",
"event_code": "EVE-000001",
"name": "Example",
"recipients": {},
"subject": "text",
"body": "text",
"is_active": true,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/mail-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/mail-rulesCreate a email rule
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
event_code | text | Yes | Event — Pick one from the catalogue, or type any screen’s event, e.g. crm.leads.created. |
name | text | Yes | Rule name |
recipients | jsonb | No | Who receives it — One to a line: an email address (ap@example.com) · actor — whoever did it · supplier — the supplier on the record · role: buyer — everybody in a role · field: requested_by — a person or address on the record · person: assignee — somebody the event names · user: <user id> |
subject | text | No | Subject — Empty for the default. {{ref}}, {{status}}, {{company}} and any field of the record fill in. |
body | text | No | Message — Empty for the default. {{link}} is a link to the record. |
is_active | boolean | No | Active |
Sample body
{
"event_code": "EVE-000001",
"name": "Example",
"recipients": {},
"subject": "text",
"body": "text",
"is_active": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"event_code": "EVE-000001",
"name": "Example",
"recipients": {},
"subject": "text",
"body": "text",
"is_active": true,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/mail-rules" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"event_code":"EVE-000001","name":"Example","recipients":{},"subject":"text","body":"text","is_active":true}'PUT/api/platform/mail-rules/{id}Change a email 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 |
|---|---|---|---|
event_code | text | Yes | Event — Pick one from the catalogue, or type any screen’s event, e.g. crm.leads.created. |
name | text | Yes | Rule name |
recipients | jsonb | No | Who receives it — One to a line: an email address (ap@example.com) · actor — whoever did it · supplier — the supplier on the record · role: buyer — everybody in a role · field: requested_by — a person or address on the record · person: assignee — somebody the event names · user: <user id> |
subject | text | No | Subject — Empty for the default. {{ref}}, {{status}}, {{company}} and any field of the record fill in. |
body | text | No | Message — Empty for the default. {{link}} is a link to the record. |
is_active | boolean | No | Active |
Sample body
{
"event_code": "EVE-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"event_code": "EVE-000001",
"name": "Example",
"recipients": {},
"subject": "text",
"body": "text",
"is_active": true,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/mail-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"event_code":"EVE-000001","name":"Example"}'DELETE/api/platform/mail-rules/{id}Delete a email 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/platform/mail-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/mail-rules/{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/platform/mail-rules/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 email 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 |
event_code | text | read, write | Event — Pick one from the catalogue, or type any screen’s event, e.g. crm.leads.created. |
name | text | read, write | Rule name |
recipients | jsonb | read, write | Who receives it — One to a line: an email address (ap@example.com) · actor — whoever did it · supplier — the supplier on the record · role: buyer — everybody in a role · field: requested_by — a person or address on the record · person: assignee — somebody the event names · user: <user id> |
subject | text | read, write | Subject — Empty for the default. {{ref}}, {{status}}, {{company}} and any field of the record fill in. |
body | text | read, write | Message — Empty for the default. {{link}} is a link to the record. |
is_active | boolean | read, write | Active |
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 Platform › Email 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.