TRANXACT.AI Help

CRM · Engagement & Retention

Intervention Management

Turning a risk into a plan somebody owns. A playbook fills in the steps.

Type REST12 operationsBase path /api/crm/interventionsPublished as /api/v1/interventions

Download specification (OpenAPI 3.1) Screen: Intervention Management

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 › Intervention Management 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.interventions · 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

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

GET/api/crm/interventionsList intervention management

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",
      "intervention_no": "INT-000001",
      "subject_type": "text",
      "subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "trigger_type": "text",
      "trigger_ref": "text",
      "playbook": "text",
      "objective": "text",
      "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "priority": "low",
      "status": "draft",
      "started_at": "2026-10-30T09:00:00Z",
      "due_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "intervention_no": "INT-000001",
  "subject_type": "text",
  "subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "trigger_type": "text",
  "trigger_ref": "text",
  "playbook": "text",
  "objective": "text",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "priority": "low",
  "status": "draft",
  "started_at": "2026-10-30T09:00:00Z",
  "due_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/interventions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/interventionsCreate a interventions

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
subject_typetextNoSubject type
subject_iduuidYesSubject id
trigger_typetextNoTrigger type
trigger_reftextNoTrigger ref
playbooktextNoPlaybook
objectivetextYesObjective
owner_iduuidNoOwner id
prioritytextNoPriority
Allowed: low medium high urgent
statustextNoStatus
started_attimestamp with time zoneNoStarted at
due_attimestamp with time zoneNoDue
outcometextNoOutcome
outcome_notestextNoNotes

Sample body

{
  "subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "objective": "text",
  "subject_type": "text",
  "trigger_type": "text",
  "trigger_ref": "text",
  "playbook": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "intervention_no": "INT-000001",
  "subject_type": "text",
  "subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "trigger_type": "text",
  "trigger_ref": "text",
  "playbook": "text",
  "objective": "text",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "priority": "low",
  "status": "draft",
  "started_at": "2026-10-30T09:00:00Z",
  "due_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/interventions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subject_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","objective":"text","subject_type":"text","trigger_type":"text","trigger_ref":"text","playbook":"text"}'
PUT/api/crm/interventions/{id}Change a interventions

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
subject_typetextNoSubject type
subject_iduuidYesSubject id
trigger_typetextNoTrigger type
trigger_reftextNoTrigger ref
playbooktextNoPlaybook
objectivetextYesObjective
owner_iduuidNoOwner id
prioritytextNoPriority
Allowed: low medium high urgent
statustextNoStatus
started_attimestamp with time zoneNoStarted at
due_attimestamp with time zoneNoDue
outcometextNoOutcome
outcome_notestextNoNotes

Sample body

{
  "subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "objective": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "intervention_no": "INT-000001",
  "subject_type": "text",
  "subject_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "trigger_type": "text",
  "trigger_ref": "text",
  "playbook": "text",
  "objective": "text",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "priority": "low",
  "status": "draft",
  "started_at": "2026-10-30T09:00:00Z",
  "due_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/interventions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subject_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","objective":"text"}'
DELETE/api/crm/interventions/{id}Delete a interventions

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

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/interventions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/interventions/{parentId}/stepsSteps

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/interventions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/interventions/{parentId}/steps/{lineId}Steps

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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 PUT "https://demo.tranxact.ai/api/crm/interventions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/interventions/{parentId}/steps/{lineId}Steps

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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 DELETE "https://demo.tranxact.ai/api/crm/interventions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/interventions/createCreate

Request body

The keys this action reads (* = required; "one of" lists the only values):

subjectType*, subjectId, triggerType, triggerRef, playbook, objective, ownerId, priority, dueInDays; subjectType one of prospect|student|applicant|contact|account; triggerType one of manual|early_alert|engagement_drop|no_response|payment_risk|attendance|survey_score|churn_risk|yield_risk; priority one of low|medium|high|urgent

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/interventions/create" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subjectType":"value","subjectId":"value","triggerType":"value","triggerRef":"value","playbook":"value","objective":"value"}'
POST/api/crm/interventions/{id}/closeClose

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

outcome, notes; outcome one of succeeded|failed|abandoned

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/interventions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"outcome":"value","notes;":"value"}'

Data model

Every field of a interventions, 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
intervention_notextread onlyIntervention no
subject_typetextread, writeSubject type
subject_iduuidread, writeSubject id
trigger_typetextread, writeTrigger type
trigger_reftextread, writeTrigger ref
playbooktextread, writePlaybook
objectivetextread, writeObjective
owner_iduuidread, writeOwner id
prioritytextread, writePriority
Allowed: low medium high urgent
statustextread, writeStatus
started_attimestamp with time zoneread, writeStarted at
due_attimestamp with time zoneread, writeDue
closed_attimestamp with time zoneread onlyClosed at
outcometextread, writeOutcome
outcome_notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Intervention Management 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.