CRM · Marketing
Segmentation
Saved audiences. A dynamic segment is rebuilt from its criteria, so it cannot quietly go stale.
/api/crm/segmentsPublished as /api/v1/segmentsOverview
| 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 › Segmentation 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.segments · 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
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/segmentsList segmentation
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",
"code": "COD-000001",
"name": "Example",
"description": "text",
"subject_type": "prospect",
"is_dynamic": true,
"criteria": {},
"member_count": 10,
"last_built_at": "2026-10-30T09:00:00Z",
"is_active": true,
"created_at": "2026-10-30T09:00:00Z",
"xf_text_1": "text",
"xf_text_2": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/segments?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/segments/{id}Read one segments
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",
"code": "COD-000001",
"name": "Example",
"description": "text",
"subject_type": "prospect",
"is_dynamic": true,
"criteria": {},
"member_count": 10,
"last_built_at": "2026-10-30T09:00:00Z",
"is_active": true,
"created_at": "2026-10-30T09:00:00Z",
"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/crm/segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/segmentsCreate a segments
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Segment code |
name | text | Yes | Name |
description | text | No | Description |
subject_type | text | No | Segment of Allowed: prospect contact account student alumni |
is_dynamic | boolean | No | Rebuild from criteria |
criteria | jsonb | No | Criteria — JSON, e.g. {"prospect_type":"student","rating":"hot","days_since_engaged_min":30} |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example",
"description": "text",
"subject_type": "prospect",
"is_dynamic": true,
"criteria": {}
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"subject_type": "prospect",
"is_dynamic": true,
"criteria": {},
"member_count": 10,
"last_built_at": "2026-10-30T09:00:00Z",
"is_active": true,
"created_at": "2026-10-30T09:00:00Z",
"xf_text_1": "text",
"xf_text_2": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/segments" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","description":"text","subject_type":"prospect","is_dynamic":true,"criteria":{}}'PUT/api/crm/segments/{id}Change a segments
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 |
|---|---|---|---|
code | text | Yes | Segment code |
name | text | Yes | Name |
description | text | No | Description |
subject_type | text | No | Segment of Allowed: prospect contact account student alumni |
is_dynamic | boolean | No | Rebuild from criteria |
criteria | jsonb | No | Criteria — JSON, e.g. {"prospect_type":"student","rating":"hot","days_since_engaged_min":30} |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"subject_type": "prospect",
"is_dynamic": true,
"criteria": {},
"member_count": 10,
"last_built_at": "2026-10-30T09:00:00Z",
"is_active": true,
"created_at": "2026-10-30T09:00:00Z",
"xf_text_1": "text",
"xf_text_2": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/crm/segments/{id}Delete a segments
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/segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/segments/{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/segments/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/segments/{id}/buildBuild
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/segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/build" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/segments/{id}/membersMembers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/members" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/segments/{id}/substack-importSubstack import
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):
file, csvResponse
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/segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/substack-import" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"file":"value","csv":"value"}'GET/api/crm/segments/{id}/substack-exportSubstack export
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/substack-export" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a segments, 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 |
code | text | read, write | Segment code |
name | text | read, write | Name |
description | text | read, write | Description |
subject_type | text | read, write | Segment of Allowed: prospect contact account student alumni |
is_dynamic | boolean | read, write | Rebuild from criteria |
criteria | jsonb | read, write | Criteria — JSON, e.g. {"prospect_type":"student","rating":"hot","days_since_engaged_min":30} |
member_count | integer | read only | Member count |
last_built_at | timestamp with time zone | read only | Last built at |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
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_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 › Segmentation 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.