CRM · Automation
Follow-up Enrolments
Who is going through which sequence, and when the next step is due.
Type REST5 operationsBase path
/api/crm/followup-enrollmentsPublished as /api/v1/followup-enrollmentsDownload specification (OpenAPI 3.1) Screen: Follow-up Enrolments
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 › Follow-up Enrolments 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.followup_enrollments · 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
5 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/followup-enrollmentsList follow-up enrolments
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",
"sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_type": "lead",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_label": "text",
"owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"email": "someone@example.com",
"next_step": 10,
"next_due_at": "2026-10-30T09:00:00Z",
"status": "active",
"steps_done": 10,
"last_step_at": "2026-10-30T09:00:00Z",
"started_at": "2026-10-30T09:00:00Z"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/followup-enrollments?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/followup-enrollments/{id}Read one follow-up enrolment
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",
"sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_type": "lead",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_label": "text",
"owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"email": "someone@example.com",
"next_step": 10,
"next_due_at": "2026-10-30T09:00:00Z",
"status": "active",
"steps_done": 10,
"last_step_at": "2026-10-30T09:00:00Z",
"started_at": "2026-10-30T09:00:00Z"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/followup-enrollments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/followup-enrollmentsCreate a follow-up enrolment
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
sequence_id | uuid | Yes | Sequence |
subject_type | text | No | For Allowed: lead opportunity account |
subject_id | uuid | Yes | Lead — The lead (or, with For set, the opportunity or account) to follow up. |
owner_id | uuid | No | Owner id |
email | text | No | |
status | text | No | Status Allowed: active stopped completed |
Sample body
{
"sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_type": "lead",
"owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"email": "someone@example.com",
"status": "active"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_type": "lead",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_label": "text",
"owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"email": "someone@example.com",
"next_step": 10,
"next_due_at": "2026-10-30T09:00:00Z",
"status": "active",
"steps_done": 10,
"last_step_at": "2026-10-30T09:00:00Z",
"started_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/followup-enrollments" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"sequence_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","subject_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","subject_type":"lead","owner_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","email":"someone@example.com","status":"active"}'PUT/api/crm/followup-enrollments/{id}Change a follow-up enrolment
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 |
|---|---|---|---|
sequence_id | uuid | Yes | Sequence |
subject_type | text | No | For Allowed: lead opportunity account |
subject_id | uuid | Yes | Lead — The lead (or, with For set, the opportunity or account) to follow up. |
owner_id | uuid | No | Owner id |
email | text | No | |
status | text | No | Status Allowed: active stopped completed |
Sample body
{
"sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_type": "lead",
"subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"subject_label": "text",
"owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"email": "someone@example.com",
"next_step": 10,
"next_due_at": "2026-10-30T09:00:00Z",
"status": "active",
"steps_done": 10,
"last_step_at": "2026-10-30T09:00:00Z",
"started_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/followup-enrollments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"sequence_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","subject_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/crm/followup-enrollments/{id}Delete a follow-up enrolment
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/followup-enrollments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a follow-up enrolment, 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 |
sequence_id | uuid | read, write | Sequence |
subject_type | text | read, write | For Allowed: lead opportunity account |
subject_id | uuid | read, write | Lead — The lead (or, with For set, the opportunity or account) to follow up. |
subject_label | text | read only | Subject label |
owner_id | uuid | read, write | Owner id |
email | text | read, write | |
next_step | integer | read only | Next step |
next_due_at | timestamp with time zone | read only | Next due at |
status | text | read, write | Status Allowed: active stopped completed |
steps_done | integer | read only | Steps done |
last_step_at | timestamp with time zone | read only | Last step at |
started_at | timestamp with time zone | read only | Started at |
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 › Follow-up Enrolments 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.